is-natural-number

What is is-natural-number?

The is-natural-number npm package is a utility for checking if a given value is a natural number. A natural number is a non-negative integer (0, 1, 2, 3, ...). This package is useful for validation purposes in various applications where ensuring the input is a natural number is necessary.

What are is-natural-number's main functionalities?

Basic Validation

This feature allows you to check if a given value is a natural number. It returns true for non-negative integers and false otherwise.

const isNaturalNumber = require('is-natural-number');

console.log(isNaturalNumber(5)); // true
console.log(isNaturalNumber(-1)); // false
console.log(isNaturalNumber(0)); // true
console.log(isNaturalNumber(3.14)); // false

Strict Mode

This feature allows you to enable strict mode where zero is not considered a natural number. By default, zero is included as a natural number.

const isNaturalNumber = require('is-natural-number');

console.log(isNaturalNumber(5, { includeZero: false })); // true
console.log(isNaturalNumber(0, { includeZero: false })); // false

Other packages similar to is-natural-number

is-integer

The is-integer package checks if a value is an integer. While it does not specifically check for natural numbers, it can be used in conjunction with additional logic to achieve similar functionality. It is more general-purpose compared to is-natural-number.

is-number

The is-number package checks if a value is a number. It is more general than is-natural-number as it does not restrict the type of number (e.g., it includes floats, negative numbers, etc.). Additional logic would be needed to filter out non-natural numbers.

validator

The validator package is a comprehensive library for string validation and sanitization. It includes a method `isInt` which can be used to check for integers, and with additional options, it can be configured to check for natural numbers. It offers a broader range of validation utilities compared to is-natural-number.

README

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

Copyright (c) 2014 - 2016 Shinnosuke Watanabe

Licensed under the MIT License.