is-natural-number.js


Check if a value is a natural number

Installation

$3

#### npm

``
npm install is-natural-number
`

#### Bower

`
bower install is-natural-number
`

#### Duo

`javascript
var isNaturalNumber = require('shinnn/is-natural-number.js');
`

$3

Download the script file directly.

API

$3

number: Number
option: Object
Return: Boolean

It returns true if the first argument is one of the natural numbers. If not, or the argument is not a number, it returns false.

`javascript
isNaturalNumber(10); //=> true

isNaturalNumber(-10); //=> false
isNaturalNumber(10.5); //=> false
isNaturalNumber(Infinity); //=> false
isNaturalNumber('10'); //=> false
`

Check the test for more detailed specifications.

#### option.includeZero

Type: Boolean
Default: false

By default the number 0 is not regarded as a natural number.

Setting this option true makes 0 regarded as a natural number.

`javascript
isNaturalNumber(0); //=> false
isNaturalNumber(0, {includeZero: true}); //=> true
``

License

Copyright (c) 2014 - 2016 Shinnosuke Watanabe

Licensed under the MIT License.