Skip to content

Latest commit

 

History

History

is-boxed-primitive

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

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 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