is-zero-or-positive-integer v1.0.4

is-zero-or-positive-integer

Deprecated in favor of the module depicts-whole-number because this is more precise with regard to the intended goals.

Node.js helper function: test variables for being a zero or a positive integer.

Installation

npm install is-zero-or-positive-integer

Usage

const isZeroOrPositiveInteger = require('is-zero-or-positive-integer')

/**
    Numbers & Strings
*/
isZeroOrPositiveInteger(0) // true
isZeroOrPositiveInteger(1) // true
isZeroOrPositiveInteger(2147483647) // true
isZeroOrPositiveInteger(Number.MAX_SAFE_INTEGER) // true
isZeroOrPositiveInteger(1e+23) // true
isZeroOrPositiveInteger('0') // true
isZeroOrPositiveInteger('1') // true
isZeroOrPositiveInteger('01') // true
isZeroOrPositiveInteger('2147483647') // true
isZeroOrPositiveInteger('9007199254740991') // true
isZeroOrPositiveInteger('1e+23') // true

isZeroOrPositiveInteger(-1) // false
isZeroOrPositiveInteger(1.2) // false
isZeroOrPositiveInteger(-1.2) // false
isZeroOrPositiveInteger(-2147483648) // false
isZeroOrPositiveInteger(Number.MIN_SAFE_INTEGER) // false
isZeroOrPositiveInteger(-1e+23) // false
isZeroOrPositiveInteger('-1') // false
isZeroOrPositiveInteger('1.2') // false
isZeroOrPositiveInteger('-1.2') // false
isZeroOrPositiveInteger('-2147483648') // false
isZeroOrPositiveInteger('-9007199254740991') // false
isZeroOrPositiveInteger('-1e+23') // false
isZeroOrPositiveInteger('string') // false

/**
    Other
*/
isZeroOrPositiveInteger(null) // false
isZeroOrPositiveInteger(undefined) // false
isZeroOrPositiveInteger('') // false
isZeroOrPositiveInteger(true) // false
isZeroOrPositiveInteger({}) // false
isZeroOrPositiveInteger([]) // false
isZeroOrPositiveInteger(/regex/) // false
isZeroOrPositiveInteger(Symbol()) // false
isZeroOrPositiveInteger(new Date()) // false
isZeroOrPositiveInteger(function() { return }) // false

Visual Represenstation Mode

When set to true the following is NOT considered a valid positive integer:

• scientific notation
• only-number-strings with leading zeros

const isZeroOrPositiveInteger = require('is-zero-or-positive-integer')

isZeroOrPositiveInteger(1e+23, true) // false
isZeroOrPositiveInteger('01', true) // false

Only Safe Integers

True is only returned for integers being less or equal than Number.MAX_SAFE_INTEGER. Visit developer.mozilla.org for further reference.

const isZeroOrPositiveInteger = require('is-zero-or-positive-integer').onlyTrueIfSafe

isZeroOrPositiveInteger(Number.MAX_SAFE_INTEGER) // true
isZeroOrPositiveInteger(Number.MAX_SAFE_INTEGER + 1) // false
isZeroOrPositiveInteger(1e+23) // false
isZeroOrPositiveInteger(Number.MAX_VALUE) // false

License

ISC