validate.io-positive-integer
v1.0.0
Published
Validates if a value is a positive integer.
Downloads
113,484
Maintainers
Readme
Positive Integer
Validates if a value is a positive integer.
Installation
$ npm install validate.io-positive-integer
For use in the browser, use browserify.
Usage
var isPositiveInteger = require( 'validate.io-positive-integer' );
isPositiveInteger( value )
Validates if a value
is a positive integer
.
var value = 5;
var bool = isPositiveInteger( value );
// returns true
Examples
var isPositiveInteger = require( 'validate.io-positive-integer' );
console.log( isPositiveInteger( 5 ) );
// returns true
console.log( isPositiveInteger( 0 ) );
// returns false
console.log( isPositiveInteger( Math.PI ) );
// returns false
console.log( isPositiveInteger( -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
Copyright
Copyright © 2015. Athan Reines.