validate.io-array-max
v1.0.1
Published
Validates if a value is an array in which no element exceeds a maximum value.
Downloads
4
Maintainers
Readme
array-max
Validates if a value is an array in which no element exceeds a maximum value.
Installation
$ npm install validate.io-array-max
For use in the browser, use browserify.
Usage
var isValid = require( 'validate.io-array-max' );
isValid( value, max )
Validates if a value
is an array
in which no element exceeds a maximum value.
var value = ['b','c','d'],
max = 'e';
var bool = isValid( value, max );
// returns true
Examples
var isValid = require( 'validate.io-array-max' );
console.log( isValid( ['b','c','d'], 'e' ) );
// returns true
console.log( isValid( [], 'a' ) );
// returns true
console.log( isValid( ['b','c','d'], 'c' ) );
// 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.