Float

Validates if a value is a float.

Installation

$ npm install validate.io-float

For use in the browser, use browserify.

Usage

var isFloat = require( 'validate.io-float' );

isFloat( value )

Validates if a value is a float.

var value = Math.PI;

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

Notes

• This method first validates that a value is a number prior to validating if the value is a float.

• In JavaScript, every numeric value is stored as a float. Here, we make a distinction based on whether the value has digits located after a decimal point. Hence, the distinction is semantic and not indicative of the underlying representation.

Examples

console.log( isFloat( 5.256 ) );
// returns true

console.log( isFloat( 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 © 2014. Athan Reines.