time-to-botec/js/node_modules/@stdlib/assert/is-boolean-array/README.md

isBooleanArray

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

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