Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cjihrig merged 1 commit into from
May 9, 2018
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down