Package Exports

@stdlib/assert-is-boolean-array

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-boolean-array) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isBooleanArray

Test if a value is an array-like object of booleans.

Installation

npm install @stdlib/assert-is-boolean-array

Usage

var isBooleanArray = require( '@stdlib/assert-is-boolean-array' );

isBooleanArray( value )

Tests if a value is an array-like object of booleans.

var bool = isBooleanArray( [ true, false, false, true ] );
// returns true

isBooleanArray.primitives( value )

Tests if a value is an array-like object containing only boolean primitives.

var bool = isBooleanArray.primitives( [ true, false ] );
// returns true

bool = isBooleanArray.primitives( [ false, new Boolean( true ) ] );
// returns false

isBooleanArray.objects( value )

Tests if a value is an array-like object containing only Boolean objects.

var bool = isBooleanArray.objects( [ new Boolean( false ), new Boolean( true ) ] );
// returns true

bool = isBooleanArray.objects( [ new Boolean( false ), true ] );
// returns false

Examples

var isBooleanArray = require( '@stdlib/assert-is-boolean-array' );

var bool = isBooleanArray( [ true, false ] );
// returns true

bool = isBooleanArray( [ true, new Boolean( false ) ] );
// returns true

bool = isBooleanArray( [ true, 'false' ] );
// returns false

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

bool = isBooleanArray( 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.

@stdlib/assert-is-boolean-array