array-like

Validates if a value is array-like.

Installation

$ npm install validate.io-array-like

For use in the browser, use browserify.

Usage

var isArrayLike = require( 'validate.io-array-like' );

isArrayLike( value )

Validates if a value is array-like.

var bool;

bool = isArrayLike( [] );
// returns true

bool = isArrayLike( {'length':10} );
// returns true

Examples

var isArrayLike = require( 'validate.io-array-like' );

console.log( isArrayLike( {'length':10} ) );
// returns true

console.log( isArrayLike( [] ) );
// returns true

console.log( isArrayLike( 'beep' ) );
// returns true

console.log( (function test(){
	return isArrayLike( arguments );
})() );
// returns true

console.log( isArrayLike( null ) );
// returns false

console.log( isArrayLike( undefined ) );
// returns false

console.log( isArrayLike( 5 ) );
// returns false

console.log( isArrayLike( true ) );
// returns false

console.log( isArrayLike( {} ) );
// returns false

console.log( isArrayLike( function(){} ) );
// 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.

3.2 KiB Raw Blame History