Installation

npm install --save @types/is-natural-number

Summary

This package contains type definitions for is-natural-number (https://github.com/shinnn/is-natural-number.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/is-natural-number.

index.d.ts

// Type definitions for is-natural-number 4.0
// Project: https://github.com/shinnn/is-natural-number.js
// Definitions by: DefinitelyTyped <https://github.com/DefinitelyTyped>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

interface Options {
    /**
     * Setting this option true makes 0 regarded as a natural number.
     */
    includeZero: boolean;
}

/**
 * Rreturns true if the first argument is one of the natural numbers.
 * If not, or the argument is not a number, it returns false.
 */
declare function isNaturalNumber(number: number | string, option?: Options): boolean;

export = isNaturalNumber;

Additional Details

Last updated: Tue, 26 Sep 2023 14:36:22 GMT
Dependencies: none
Global values: none

Credits

These definitions were written by DefinitelyTyped.

Current Tags

3 Versions

4.0.2 ... 3 years ago
4.0.1 ... 4 years ago
4.0.0 ... 7 years ago