README

Interval

Validates if a value exists on a specified interval.

Installation

$ npm install validate.io-interval

For use in the browser, use browserify.

Usage

var onInterval = require( 'validate.io-interval' );

onInterval( value, lower, upper )

Validates if a value exists on a specified interval [lower, upper], where lower is the lower interval bound (inclusive) and upper is the upper interval bound (inclusive).

var value = 5,
    lower = 0,
    upper = 10;

var bool = onInterval( value, lower, upper );
// returns true

Note: all arguments must be numeric. If provided non-numeric arguments, the method returns false.

Examples

console.log( onInterval( 3, 0, 6 ) );
// returns true

console.log( onInterval( 3, 4, 10 ) );
// 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-interval

Usage no npm install needed!