validate.io-finite v1.0.0

Finite

Validates if a value is a finite number.

Installation

$ npm install validate.io-finite

For use in the browser, use browserify.

Usage

var isFiniteNumber = require( 'validate.io-finite' );

isFiniteNumber( value )

Validates if a value is a finite number.

var value = Number.MAX_VALUE;

var bool = isFiniteNumber( value );
// returns true

Note: this method differs from the global method isFinite() in that the global method will validate non-numeric values. For any non-numeric value, this method returns false.

Examples

var isFiniteNumber = require( 'validate.io-finite' );

console.log( isFiniteNumber( Number.MAX_VALUE ) );
// returns true

console.log( isFiniteNumber( Number.POSITIVE_INFINITY ) );
// returns false

console.log( isFiniteNumber( NaN ) );
// returns false

console.log( isFiniteNumber( '5' ) );
// 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

Copyright © 2015. Athan Reines.