validate.io-matches

Validates if a value matches any one of a specified set of values.

Showing:

Popularity

Downloads/wk

2

GitHub Stars

2

Maintenance

Last Commit

7yrs ago

Contributors

0

Package

Dependencies

2

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Matches

NPM version Build Status Coverage Status Dependencies

Validates if a value matches any one of a set of specified values.

Installation

$ npm install validate.io-matches

For use in the browser, use browserify.

Usage

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

matches( value, options )

Validates if a value matches any one of a set of specified values.

var value = 'c',
    options = 'a,b,c,d,e';

var bool = matches( value, options );
// returns true

Notes

  • This method applies __only__ to `string` and `number` value types. For any other type, the method returns `false`.
    
  • numeric values are converted to strings.
  • The list of acceptable `matches` should be serialized as a comma-delimited `string`.
    

Examples

console.log( matches( 'beep', 'beep,boop,bop' ) );
// returns true

var opts = [1,3,5,7,9];
console.log( matches( 5, opts.join(',') ) );
// returns true

console.log( matches( 'bap', 'beep,boop,bop' ) );
// 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 © 2014. Athan Reines.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial