Skip to content

Commit

Permalink
doc: add isBigIntObject to documentation
Browse files Browse the repository at this point in the history
Refs: nodejs#19989
Fixes: nodejs#55446
PR-URL: nodejs#55450
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
leviscar authored and tpoisseau committed Nov 21, 2024
1 parent a5f6a0b commit fd370cc
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -2379,6 +2379,24 @@ util.types.isBigInt64Array(new BigInt64Array()); // Returns true
util.types.isBigInt64Array(new BigUint64Array()); // Returns false
```
### `util.types.isBigIntObject(value)`
<!-- YAML
added: v10.4.0
-->
* `value` {any}
* Returns: {boolean}
Returns `true` if the value is a BigInt object, e.g. created
by `Object(BigInt(123))`.
```js
util.types.isBigIntObject(Object(BigInt(123))); // Returns true
util.types.isBigIntObject(BigInt(123)); // Returns false
util.types.isBigIntObject(123); // Returns false
```
### `util.types.isBigUint64Array(value)`
<!-- YAML
Expand Down

0 comments on commit fd370cc

Please sign in to comment.