https://github.com/shinnn/is-natural-number.js

Check if a value is natural number
https://github.com/shinnn/is-natural-number.js

javascript natural-numbers number

Last synced: 26 days ago
JSON representation

Check if a value is natural number

• Host: GitHub
• URL: https://github.com/shinnn/is-natural-number.js
• Owner: shinnn
• License: mit
• Created: 2014-11-23T09:58:36.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-30T10:27:09.000Z (almost 8 years ago)
• Last Synced: 2024-09-19T02:45:29.458Z (about 2 months ago)
• Topics: javascript, natural-numbers, number
• Language: JavaScript
• Homepage: https://runkit.com/npm/is-natural-number
• Size: 18.6 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# is-natural-number.js

[![NPM version](https://img.shields.io/npm/v/is-natural-number.svg)](https://www.npmjs.com/package/is-natural-number)

[![Bower version](https://img.shields.io/bower/v/is-natural-number.svg)](https://github.com/shinnn/is-natural-number.js/releases)

[![Build Status](https://travis-ci.org/shinnn/is-natural-number.js.svg)](https://travis-ci.org/shinnn/is-natural-number.js)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/is-natural-number.js.svg)](https://coveralls.io/r/shinnn/is-natural-number.js?branch=master)

[![devDependency Status](https://david-dm.org/shinnn/is-natural-number.js/dev-status.svg)](https://david-dm.org/shinnn/is-natural-number.js#info=devDependencies)

Check if a value is a [natural number](https://wikipedia.org/wiki/Natural_number)

## Installation

### Package managers

#### [npm](https://www.npmjs.com/)

```

npm install is-natural-number

```

#### [Bower](http://bower.io/)

```

bower install is-natural-number

```

#### [Duo](http://duojs.org/)

```javascript

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

```

### Standalone

[Download the script file directly.](https://raw.githubusercontent.com/shinnn/is-natural-number.js/master/is-natural-number.js)

## 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`.

```javascript

isNaturalNumber(10); //=> true

isNaturalNumber(-10); //=> false

isNaturalNumber(10.5); //=> false

isNaturalNumber(Infinity); //=> false

isNaturalNumber('10'); //=> false

```

*Check [the test](./test.js) 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](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).