You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
2.9 KiB
116 lines
2.9 KiB
4 years ago
|
Positive Integer
|
||
|
|
===
|
||
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]
|
||
|
|
|
||
|
|
> Validates if a value is a positive integer.
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ npm install validate.io-positive-integer
|
||
|
|
```
|
||
|
|
|
||
|
|
For use in the browser, use [browserify](https://github.com/substack/node-browserify).
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
``` javascript
|
||
|
|
var isPositiveInteger = require( 'validate.io-positive-integer' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### isPositiveInteger( value )
|
||
|
|
|
||
|
|
Validates if a `value` is a positive `integer`.
|
||
|
|
|
||
|
|
``` javascript
|
||
|
|
var value = 5;
|
||
|
|
|
||
|
|
var bool = isPositiveInteger( value );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
``` javascript
|
||
|
|
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,
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ node ./examples/index.js
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
|
||
|
|
### Unit
|
||
|
|
|
||
|
|
Unit tests use the [Mocha](http://mochajs.org) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ make test
|
||
|
|
```
|
||
|
|
|
||
|
|
All new feature development should have corresponding unit tests to validate correct functionality.
|
||
|
|
|
||
|
|
|
||
|
|
### Test Coverage
|
||
|
|
|
||
|
|
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ make test-cov
|
||
|
|
```
|
||
|
|
|
||
|
|
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ make view-cov
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
---
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT license](http://opensource.org/licenses/MIT).
|
||
|
|
|
||
|
|
|
||
|
|
## Copyright
|
||
|
|
|
||
|
|
Copyright © 2015. Athan Reines.
|
||
|
|
|
||
|
|
|
||
|
|
[npm-image]: http://img.shields.io/npm/v/validate.io-positive-integer.svg
|
||
|
|
[npm-url]: https://npmjs.org/package/validate.io-positive-integer
|
||
|
|
|
||
|
|
[travis-image]: http://img.shields.io/travis/validate-io/positive-integer/master.svg
|
||
|
|
[travis-url]: https://travis-ci.org/validate-io/positive-integer
|
||
|
|
|
||
|
|
[coveralls-image]: https://img.shields.io/coveralls/validate-io/positive-integer/master.svg
|
||
|
|
[coveralls-url]: https://coveralls.io/r/validate-io/positive-integer?branch=master
|
||
|
|
|
||
|
|
[dependencies-image]: http://img.shields.io/david/validate-io/positive-integer.svg
|
||
|
|
[dependencies-url]: https://david-dm.org/validate-io/positive-integer
|
||
|
|
|
||
|
|
[dev-dependencies-image]: http://img.shields.io/david/dev/validate-io/positive-integer.svg
|
||
|
|
[dev-dependencies-url]: https://david-dm.org/dev/validate-io/positive-integer
|
||
|
|
|
||
|
|
[github-issues-image]: http://img.shields.io/github/issues/validate-io/positive-integer.svg
|
||
|
|
[github-issues-url]: https://github.com/validate-io/positive-integer/issues
|