# @types/is-natural-number

> TypeScript definitions for is-natural-number

Latest version **4.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/is-natural-number
pnpm add @types/is-natural-number
yarn add @types/is-natural-number
bun add @types/is-natural-number
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.4 |
| Published | 2023-11-07 |
| First published | 2019-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/is-natural-number
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/is-natural-number
- npm.io page: https://npm.io/package/@types/is-natural-number

## Recent versions

- 4.0.4 (latest) — 2023-11-07
- 4.0.1 (ts3.8) — 2021-12-24
- 4.0.0 (ts2.0) — 2019-02-23
- 4.0.3 — 2023-10-18
- 4.0.2 — 2023-09-26

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/is-natural-number/index.d.ts)
````ts
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, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by .

---
_Source: https://npm.io/package/@types/is-natural-number · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._