@stdlib/assert-is-boolean
v0.2.2
Published
Test if a value is a boolean.
Downloads
1,872,123
Readme
isBoolean
Test if a value is a boolean.
Installation
npm install @stdlib/assert-is-boolean
Usage
var isBoolean = require( '@stdlib/assert-is-boolean' );
isBoolean( value )
Tests if a value
is a boolean
.
var Boolean = require( '@stdlib/boolean-ctor' );
var bool = isBoolean( false );
// returns true
bool = isBoolean( true );
// returns true
bool = isBoolean( new Boolean( false ) );
// returns true
bool = isBoolean( new Boolean( true ) );
// returns true
isBoolean.isPrimitive( value )
Tests if a value
is a primitive boolean
.
var Boolean = require( '@stdlib/boolean-ctor' );
var bool = isBoolean.isPrimitive( true );
// returns true
bool = isBoolean.isPrimitive( false );
// returns true
bool = isBoolean.isPrimitive( new Boolean( true ) );
// returns false
isBoolean.isObject( value )
Tests if a value
is a Boolean
object.
var Boolean = require( '@stdlib/boolean-ctor' );
var bool = isBoolean.isObject( true );
// returns false
bool = isBoolean.isObject( new Boolean( false ) );
// returns true
Examples
var Boolean = require( '@stdlib/boolean-ctor' );
var isBoolean = require( '@stdlib/assert-is-boolean' );
var bool = isBoolean( false );
// returns true
bool = isBoolean( new Boolean( false ) );
// returns true
bool = isBoolean( 'true' );
// returns false
bool = isBoolean( null );
// returns false
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.