isBoxedPrimitive

Test if a value is a JavaScript boxed primitive.

Installation

npm install @stdlib/assert-is-boxed-primitive

Usage

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

isBoxedPrimitive( value )

Tests if a value is a JavaScript boxed primitive.

var Boolean = require( '@stdlib/boolean-ctor' );

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 Boolean = require( '@stdlib/boolean-ctor' );
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

See Also

• @stdlib/assert-is-primitive: test if a value is a JavaScript primitive.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.