doc: add util.types.isBig{Int,Uint}64Array()

These methods are exposed, even though the BigInt64Array and BigUint64Array types are currently behind the --harmony-bigint command line flag. PR-URL: #20615 Fixes: #20602 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · May 12, 2018 · c546746 · c546746
1 parent d568952
commit c546746
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -1009,6 +1009,44 @@ util.types.isAsyncFunction(function foo() {});  // Returns false
 util.types.isAsyncFunction(async function foo() {});  // Returns true
 ```
 
+### util.types.isBigInt64Array(value)
+<!-- YAML
+added: v10.0.0
+-->
+
+* Returns: {boolean}
+
+Returns `true` if the value is a `BigInt64Array` instance. The
+`--harmony-bigint` command line flag is required in order to use the
+`BigInt64Array` type, but it is not required in order to use
+`isBigInt64Array()`.
+
+For example:
+
+```js
+util.types.isBigInt64Array(new BigInt64Array());   // Returns true
+util.types.isBigInt64Array(new BigUint64Array());  // Returns false
+```
+
+### util.types.isBigUint64Array(value)
+<!-- YAML
+added: v10.0.0
+-->
+
+* Returns: {boolean}
+
+Returns `true` if the value is a `BigUint64Array` instance. The
+`--harmony-bigint` command line flag is required in order to use the
+`BigUint64Array` type, but it is not required in order to use
+`isBigUint64Array()`.
+
+For example:
+
+```js
+util.types.isBigUint64Array(new BigInt64Array());   // Returns false
+util.types.isBigUint64Array(new BigUint64Array());  // Returns true
+```
+
 ### util.types.isBooleanObject(value)
 <!-- YAML
 added: v10.0.0