Skip to content

stdlib-js/assert-is-boolean-array

Repository files navigation

isBooleanArray

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

isBooleanArray = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-boolean-array@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var isBooleanArray = require( 'path/to/vendor/umd/assert-is-boolean-array/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-boolean-array@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.isBooleanArray;
})();
</script>

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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-boolean-array@umd/browser.js"></script>
<script type="text/javascript">
(function () {

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

})();
</script>
</body>
</html>

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.