Size
Validates if a value is a multidimensional array of specified dimensions.
Installation
$ npm install validate.io-size
For use in the browser, use browserify.
Usage
var isSize = ;
isSize( value, size )
Validates if a value
is a multidimensional array
of specified dimensions.
var value =1234;var bool = ;// returns true
To restrict validation to particular dimensions, use a wildcard; i.e., anything which is not a nonnegative integer
.
var value =123456789101112;// Validate only the first and third dimensions:var bool = ;// returns true// Validate only the third dimension:bool = ;// returns true// Only validate that the input value is a 3d array:bool = ;// returns true
Note: for each dimension, the method validates that the dimension is an array
. For all other types, the method will return false
.
Examples
var isSize = ;var arr =1234;console;// returns trueconsole;// returns trueconsole;// returns falsearr 1 ;console;// 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.