diff options
author | cjihrig <cjihrig@gmail.com> | 2018-05-08 22:30:16 -0400 |
---|---|---|
committer | cjihrig <cjihrig@gmail.com> | 2018-05-09 13:57:13 -0400 |
commit | 2246c3c843efd32d8c573c0228bbc289a46c28b7 (patch) | |
tree | b9e427a5fea97b1a39fa80b8861c4001e4a4e5b8 /doc | |
parent | 06dc96fa7cc91c9ba4c776f73fef0e509f853ab2 (diff) | |
download | android-node-v8-2246c3c843efd32d8c573c0228bbc289a46c28b7.tar.gz android-node-v8-2246c3c843efd32d8c573c0228bbc289a46c28b7.tar.bz2 android-node-v8-2246c3c843efd32d8c573c0228bbc289a46c28b7.zip |
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: https://github.com/nodejs/node/pull/20615
Fixes: https://github.com/nodejs/node/issues/20602
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/util.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/api/util.md b/doc/api/util.md index 529f7b6fc7..b0e511c3cd 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1025,6 +1025,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 |