@stdlib/assert-is-primitive
v0.2.2
Published
Test if a value is a JavaScript primitive.
Downloads
1,305
Readme
isPrimitive
Test if a value is a JavaScript primitive.
Installation
npm install @stdlib/assert-is-primitive
Usage
var isPrimitive = require( '@stdlib/assert-is-primitive' );
isPrimitive( value )
Tests if a value
is a JavaScript primitive.
var bool = isPrimitive( false );
// returns true
Notes
Seven primitives:
string
number
boolean
null
undefined
symbol
(ES6/ES2015)bigint
(ES11/ES2020)
Examples
var Boolean = require( '@stdlib/boolean-ctor' );
var Object = require( '@stdlib/object-ctor' );
var isPrimitive = require( '@stdlib/assert-is-primitive' );
var bool = isPrimitive( false );
// returns true
bool = isPrimitive( 0 );
// returns true
bool = isPrimitive( '' );
// returns true
bool = isPrimitive( null );
// returns true
bool = isPrimitive( void 0 );
// returns true
bool = isPrimitive( [] );
// returns false
bool = isPrimitive( {} );
// returns false
bool = isPrimitive( function noop() {} );
// returns false
bool = isPrimitive( new Boolean() );
// returns false
bool = isPrimitive( new String() );
// returns false
bool = isPrimitive( new Array() );
// returns false
bool = isPrimitive( new Object() );
// returns false
See Also
@stdlib/assert-is-boxed-primitive
: test if a value is a JavaScript boxed 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.