which-boxed-primitive
Advanced tools
Package description
The `which-boxed-primitive` npm package is designed to help developers identify the type of boxed primitives (objects that encapsulate primitive values) in JavaScript. This can be particularly useful when working with code that needs to distinguish between different types of object wrappers around primitive values, such as `Number`, `String`, `Boolean`, `Symbol`, `BigInt`, etc.
Identifying boxed primitives
This feature allows developers to pass an object to the `whichBoxedPrimitive` function and receive a string indicating the type of boxed primitive, or `undefined` if the object is not a boxed primitive. This can be useful for type checking and ensuring that certain operations are only performed on the expected types of objects.
"use strict";\nconst whichBoxedPrimitive = require('which-boxed-primitive');\n\nconsole.log(whichBoxedPrimitive(new String('hello'))); // 'String'\nconsole.log(whichBoxedPrimitive(new Number(123))); // 'Number'\nconsole.log(whichBoxedPrimitive(new Boolean(true))); // 'Boolean'\nconsole.log(whichBoxedPrimitive(Object(Symbol('sym')))); // 'Symbol'\nconsole.log(whichBoxedPrimitive(Object(BigInt(10)))); // 'BigInt'\nconsole.log(whichBoxedPrimitive([])); // undefined (not a boxed primitive)"The `kind-of` package is similar to `which-boxed-primitive` in that it provides a way to check the type of a value in JavaScript. However, `kind-of` goes beyond just boxed primitives and can identify many other types, including arrays, regular expressions, dates, and more. This makes `kind-of` more versatile for general type checking, but potentially less focused if the specific need is to identify boxed primitives.
The `is` package offers a collection of type-check functions, such as `is.string`, `is.number`, and so on, which can be used to determine the type of a given value. While it includes functions for checking boxed types (e.g., `is.object` and specific checks for boxed types), it is broader in scope and includes checks for many other types of values. Compared to `which-boxed-primitive`, `is` provides a more granular approach to type checking at the cost of requiring more specific function calls for each type.
Changelog
v1.0.2 - 2020-12-14
8674582dff6643b26112aauto-changelog config consistent 8d10175ab8db24nyc on all tests; use tape runner 7d084dfeslint, @ljharb/eslint-config, aud, auto-changelog, object-inspect, tape 576f6f397efa53fb1b4f7eslint, @ljharb/eslint-config, has-symbols, object-inspect, safe-publish-latest 1e03c61is-boolean-object, is-number-object, is-string, is-symbol 13673dfauto-changelog, in-publish, tape 65a0e15eslint, @ljharb/eslint-config, tape f8a0afeis-bigint, is-boolean-object e7a1ce2pull_request_target event e46f193@ljharb/eslint-config, tape df3da14auto-changelog; add aud e2e8a12funding field 7df404bauto-changelog 0d6b76d246151cc2d168525fb2b5Readme
Which kind of boxed JS primitive is this? This module works cross-realm/iframe, does not depend on instanceof or mutable properties, and works despite ES6 Symbol.toStringTag.
var whichBoxedPrimitive = require('which-boxed-primitive');
var assert = require('assert');
// unboxed primitives return `null`
// boxed primitives return the builtin constructor name
assert.equal(whichBoxedPrimitive(undefined), null);
assert.equal(whichBoxedPrimitive(null), null);
assert.equal(whichBoxedPrimitive(false), null);
assert.equal(whichBoxedPrimitive(true), null);
assert.equal(whichBoxedPrimitive(new Boolean(false)), 'Boolean');
assert.equal(whichBoxedPrimitive(new Boolean(true)), 'Boolean');
assert.equal(whichBoxedPrimitive(42), null);
assert.equal(whichBoxedPrimitive(NaN), null);
assert.equal(whichBoxedPrimitive(Infinity), null);
assert.equal(whichBoxedPrimitive(new Number(42)), 'Number');
assert.equal(whichBoxedPrimitive(new Number(NaN)), 'Number');
assert.equal(whichBoxedPrimitive(new Number(Infinity)), 'Number');
assert.equal(whichBoxedPrimitive(''), null);
assert.equal(whichBoxedPrimitive('foo'), null);
assert.equal(whichBoxedPrimitive(new String('')), 'String');
assert.equal(whichBoxedPrimitive(new String('foo')), 'String');
assert.equal(whichBoxedPrimitive(Symbol()), null);
assert.equal(whichBoxedPrimitive(Object(Symbol()), 'Symbol');
assert.equal(whichBoxedPrimitive(42n), null);
assert.equal(whichBoxedPrimitive(Object(42n), 'BigInt');
// non-boxed-primitive objects return `undefined`
assert.equal(whichBoxedPrimitive([]), undefined);
assert.equal(whichBoxedPrimitive({}), undefined);
assert.equal(whichBoxedPrimitive(/a/g), undefined);
assert.equal(whichBoxedPrimitive(new RegExp('a', 'g')), undefined);
assert.equal(whichBoxedPrimitive(new Date()), undefined);
assert.equal(whichBoxedPrimitive(function () {}), undefined);
assert.equal(whichBoxedPrimitive(function* () {}), undefined);
assert.equal(whichBoxedPrimitive(x => x * x), undefined);
assert.equal(whichBoxedPrimitive([]), undefined);
Simply clone the repo, npm install, and run npm test
FAQs
Which kind of boxed JS primitive is this?
The npm package which-boxed-primitive receives a total of 22,347,211 weekly downloads. As such, which-boxed-primitive popularity was classified as popular.
We found that which-boxed-primitive demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.