doc: add isBigIntObject to documentation

Refs: #55446
nodejs · Oct 18, 2024 · 4e89e62 · 4e89e62
1 parent 9f5000e
commit 4e89e62
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -2359,6 +2359,24 @@ util.types.isBigInt64Array(new BigInt64Array()); // Returns true
 util.types.isBigInt64Array(new BigUint64Array()); // Returns false
 ```
 
+### `util.types.isBigIntObject(value)`
+
+<!-- YAML
+added: v22.9.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