validate.io-number-array-min
v1.0.1
Published
Validates if a value is a numeric array in which no element exceeds a minimum value.
Downloads
16
Maintainers
Readme
number-array-min
Validates if a value is a numeric array in which no element exceeds a minimum value.
Installation
$ npm install validate.io-number-array-min
For use in the browser, use browserify.
Usage
var isValid = require( 'validate.io-number-array-min' );
isValid( value, min )
Validates if a value
is a numeric array
in which no element exceeds a minimum value.
var value = [1,2,3],
min = 1;
var bool = isValid( value, min );
// returns true
Examples
var isValid = require( 'validate.io-number-array-min' );
console.log( isValid( [1,2,3], 1 ) );
// returns true
console.log( isValid( [], 1 ) );
// returns true
console.log( isValid( [1,2,3], 2 ) );
// returns false
console.log( isValid( [1,NaN,3], 1 ) );
// 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.