README

Logical Array

Validates if a value is a logical array.

A logical array is defined as an array consisting exclusively of 0s and 1s. The definition is purely conventional, but such arrays are useful when wanting to combine, e.g., boolean-like filtering with element-by-element array multiplication. Similar use cases are common in numerical computing environments.

Installation

$ npm install validate.io-logical-array

For use in the browser, use browserify.

Usage

var isLogicalArray = require( 'validate.io-logical-array' );

isLogicalArray( value )

Validates if a value is a logical array; i.e., an array consisting solely of numeric 0s and 1s.

var arr = [ 1, 0, 0, 1, 1 ];

var bool = isLogicalArray( arr );
// returns true

Note: the method will return false for an empty array.

Examples

var isLogicalArray = require( 'validate.io-logical-array' );

console.log( isLogicalArray( [1,0,0,1,1] ) );
// returns true

console.log( isLogicalArray( [] ) );
// returns false

console.log( isLogicalArray( [true,false] ) );
// returns false

console.log( isLogicalArray( [1,2,3] ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

validate.io-logical-array

Usage no npm install needed!