summaryrefslogtreecommitdiff
path: root/doc/api/util.md
diff options
context:
space:
mode:
authorRuben Bridgewater <ruben@bridgewater.de>2018-08-26 13:46:24 +0200
committerRuben Bridgewater <ruben@bridgewater.de>2018-09-05 20:53:59 +0200
commit3209679b7f9ec9bd3ffc6cf2c56c6c5583be6b87 (patch)
tree3c93455f54a38550f583dc0cc5eec0d4c687584e /doc/api/util.md
parentc9d6e3ff04c4f16eacc0a9756d4c464888444d22 (diff)
downloadandroid-node-v8-3209679b7f9ec9bd3ffc6cf2c56c6c5583be6b87.tar.gz
android-node-v8-3209679b7f9ec9bd3ffc6cf2c56c6c5583be6b87.tar.bz2
android-node-v8-3209679b7f9ec9bd3ffc6cf2c56c6c5583be6b87.zip
util: add util.types.isBoxedPrimitive
Checking all boxed primitives individually requires to cross the C++ barrier multiple times besides being more complicated than just a single check. PR-URL: https://github.com/nodejs/node/pull/22620 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/util.md')
-rw-r--r--doc/api/util.md27
1 files changed, 24 insertions, 3 deletions
diff --git a/doc/api/util.md b/doc/api/util.md
index a9340847c5..44495e977d 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -1049,10 +1049,31 @@ by `new Boolean()`.
```js
util.types.isBooleanObject(false); // Returns false
util.types.isBooleanObject(true); // Returns false
-util.types.isBooleanObject(new Boolean(false)); // Returns true
-util.types.isBooleanObject(new Boolean(true)); // Returns true
+util.types.isBooleanObject(new Boolean(false)); // Returns true
+util.types.isBooleanObject(new Boolean(true)); // Returns true
util.types.isBooleanObject(Boolean(false)); // Returns false
-util.types.isBooleanObject(Boolean(true)); // Returns false
+util.types.isBooleanObject(Boolean(true)); // Returns false
+```
+
+### util.types.isBoxedPrimitive(value)
+<!-- YAML
+added: REPLACEME
+-->
+
+* `value` {any}
+* Returns: {boolean}
+
+Returns `true` if the value is any boxed primitive object, e.g. created
+by `new Boolean()`, `new String()` or `Object(Symbol())`.
+
+For example:
+
+```js
+util.types.isBoxedPrimitive(false); // Returns false
+util.types.isBoxedPrimitive(new Boolean(false)); // Returns true
+util.types.isBoxedPrimitive(Symbol('foo')); // Returns false
+util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
+util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
```
### util.types.isDataView(value)