README
arguments
Validates if a value is an arguments object.
Installation
$ npm install validate.io-arguments
For use in the browser, use browserify.
Usage
var isArguments = require( 'validate.io-arguments' );
isArguments( value )
Validates if a value
is an arguments
object.
function foo() {
return isArguments( arguments );
}
var bool = foo();
// returns true
Examples
var isArguments = require( 'validate.io-arguments' );
function foo() {
return isArguments( arguments );
}
console.log( foo() );
// returns true
console.log( isArguments( [] ) );
// returns false
console.log( isArguments( {} ) );
// returns false
console.log( isArguments( null ) );
// 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.