Package Exports

validate.io-contains

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (validate.io-contains) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Contains

Validates if an array contains an input value.

Installation

$ npm install validate.io-contains

For use in the browser, use browserify.

Usage

var contains = require( 'validate.io-contains' );

contains( arr, value )

Validates if an array contains an input value.

var arr = [ 1, '2', 3 ];

var bool = contains( arr, '2' );
// returns true

bool = contains( arr, 2 );
// returns false

Note: if not provided an array, the function will throw an Error.

Examples

var contains = require( 'validate.io-contains' );

var arr = [ 1, '2', NaN, null, {} ];

console.log( contains( arr, '2' ) );
// returns true

console.log( contains( arr, NaN ) );
// returns true

console.log( contains( arr, 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.

validate.io-contains