README
Primitive Array
Validates if a value is an array of JavaScript primitives.
Installation
$ npm install validate.io-primitive-array
For use in the browser, use browserify.
Usage
var isPrimitiveArray = require( 'validate.io-primitive-array' );
isPrimitiveArray( value )
Validates if a value
is an array
of JavaScript primitives.
var value = [ false, null, undefined, '', 0 ];
var bool = isPrimitiveArray( value );
// returns true
Note: the method returns false
for an empty array
.
Examples
var isPrimitiveArray = require( 'validate.io-primitive-array' );
console.log( isPrimitiveArray( [null,undefined,'',0,false] ) );
// returns true
console.log( isPrimitiveArray( [] ) );
// returns false
console.log( isPrimitiveArray( [[],{}] ) );
// returns false
console.log( isPrimitiveArray( [new Boolean(), new Number(), new String()] ) );
// 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
Copyright
Copyright © 2015. Athan Reines.