History

Kate Temkin c893a86e54 initial commit of template		2024-04-26 22:49:34 -06:00
..
index.js	initial commit of template	2024-04-26 22:49:34 -06:00
index.jsnext.js	initial commit of template	2024-04-26 22:49:34 -06:00
LICENSE	initial commit of template	2024-04-26 22:49:34 -06:00
package.json	initial commit of template	2024-04-26 22:49:34 -06:00
README.md	initial commit of template	2024-04-26 22:49:34 -06:00

README.md

is-natural-number.js

Check if a value is a natural number

Installation

Package managers

npm

npm install is-natural-number

Bower

bower install is-natural-number

Duo

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

Standalone

Download the script file directly.

API

isNaturalNumber(number, option)

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.

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.

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

License

Licensed under the MIT License.