time-to-botec/js/node_modules/@stdlib/assert/is-boxed-primitive/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.3 KiB

isBoxedPrimitive

Test if a value is a JavaScript boxed primitive.

Usage

var isBoxedPrimitive = require( '@stdlib/assert/is-boxed-primitive' );

isBoxedPrimitive( value )

Tests if a value is a JavaScript boxed primitive.

var bool = isBoxedPrimitive( new Boolean( false ) );
// returns true

bool = isBoxedPrimitive( true );
// returns false

Notes

  • Boxed primitive objects can be created with one of the following:

    • new Boolean()
    • new Number()
    • new String()
    • Object( Symbol() ) (ES6/ES2015)

Examples

var Number = require( '@stdlib/number/ctor' );
var isBoxedPrimitive = require( '@stdlib/assert/is-boxed-primitive' );

var bool = isBoxedPrimitive( new Boolean( false ) );
// returns true

bool = isBoxedPrimitive( new String( 'beep' ) );
// returns true

bool = isBoxedPrimitive( new Number( 3.14 ) );
// returns true

bool = isBoxedPrimitive( false );
// returns false

bool = isBoxedPrimitive( 0 );
// returns false

bool = isBoxedPrimitive( '' );
// returns false

bool = isBoxedPrimitive( null );
// returns false

bool = isBoxedPrimitive( void 0 );
// returns false

bool = isBoxedPrimitive( [] );
// returns false

bool = isBoxedPrimitive( {} );
// returns false