number-array-max

Validates if a value is a numeric array in which no element exceeds a maximum value.

Installation

$ npm install validate.io-number-array-max

For use in the browser, use browserify.

Usage

var isValid = require( 'validate.io-number-array-max' );

isValid( value, max )

Validates if a value is a numeric array in which no element exceeds a maximum value.

var value = [1,2,3],
	max = 4;

var bool = isValid( value, max );
// returns true

Examples

var isValid = require( 'validate.io-number-array-max' );

console.log( isValid( [1,2,3], 4 ) );
// returns true

console.log( isValid( [], 4 ) );
// returns true

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

console.log( isValid( [1,NaN,3], 4 ) );
// 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.

Copyright

Copyright © 2015. Athan Reines.