README
Nonpositive
Validates if a value is a nonpositive number.
Installation
$ npm install validate.io-nonpositive
For use in the browser, use browserify.
Usage
var isNonPositive = require( 'validate.io-nonpositive' );
isNonPositive( value )
Validates if a value
is a nonpositive number
.
var value = -Math.PI;
var bool = isNonPositive( value );
// returns true
Examples
var isNonPositive = require( 'validate.io-nonpositive' );
console.log( isNonPositive( -Math.PI ) );
// returns true
console.log( isNonPositive( 0 ) );
// returns true
console.log( isNonPositive( 1 ) );
// 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
Copyright
Copyright © 2015. Athan Reines.