Socket
Socket
Sign inDemoInstall

is-natural-number

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    is-natural-number

Check if a value is a natural number


Version published
Maintainers
1
Install size
6.67 kB
Created

Readme

Source

is-natural-number.js

NPM version Bower version Build Status Coverage Status devDependency Status

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

Copyright (c) 2014 - 2016 Shinnosuke Watanabe

Licensed under the MIT License.

Keywords

FAQs

Last updated on 16 May 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc