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 = require( 'validate.io-size' );

isSize( value, size )

Validates if a value is a multidimensional array of specified dimensions.

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

var bool = isSize( value, [2,2] );
// returns true

To restrict validation to particular dimensions, use a wildcard; i.e., anything which is not a nonnegative integer.

var value = [
	[[1,2,3],[4,5,6]],
	[[7,8,9],[10,11,12]]
];

// Validate only the first and third dimensions:
var bool = isSize( value, [2,'*',3] );
// returns true

// Validate only the third dimension:
bool = isSize( value, [null,null,3] );
// returns true

// Only validate that the input value is a 3d array:
bool = isSize( value, ['*','*','*'] );
// 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 = require( 'validate.io-size' );

var arr = [
	[1,2],
	[3,4]
];
console.log( isSize( arr, [2,2] ) );
// returns true

console.log( isSize( arr, [2] ) );
// returns true

console.log( isSize( arr, [2,3] ) );
// returns false

arr[ 1 ].push( 5 );
console.log( isSize( arr, [2,2] ) );
// 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.