Have ideas to improve npm?Join in the discussion! »

    is-natural-number
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/is-natural-number package

    4.0.1 • Public • Published

    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.

    Install

    npm i is-natural-number

    DownloadsWeekly Downloads

    4,792,094

    Version

    4.0.1

    License

    MIT

    Last publish

    Collaborators

    • avatar