# @types/natural-sort

> TypeScript definitions for natural-sort

Latest version **1.0.0** (published 2024-10-14) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-10-14 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51419 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2024-10-14
- 0.0.24 (ts4.5) — 2023-11-07
- 0.0.21 (ts4.2) — 2021-07-08
- 0.0.20 (ts2.5) — 2018-05-10
- 0.0.23 — 2023-10-18
- 0.0.22 — 2023-09-23
- 0.0.19 — 2016-09-19
- 0.0.18 — 2016-07-14
- 0.0.17-alpha — 2016-07-08
- 0.0.16-alpha — 2016-07-04
- 0.0.15-alpha — 2016-07-02
- 0.0.14-alpha — 2016-07-01
- 0.0.13-alpha — 2016-07-01
- 0.0.12-alpha — 2016-05-25
- 0.0.11-alpha — 2016-05-20
- … 2 more at https://npm.io/package/@types/natural-sort/versions

## README

# Installation
> `npm install --save @types/natural-sort`

# Summary
This package contains type definitions for natural-sort (https://github.com/studio-b12/natural-sort).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/natural-sort.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/natural-sort/index.d.ts)
````ts
export as namespace naturalSort;

declare namespace naturalSort {
    interface Options {
        /** Set to true to make the sort case-sensitive. */
        caseSensitive?: boolean | undefined;

        /** Set to 'desc' to sort in reverse. */
        direction?: "desc" | undefined;
    }
}

declare function naturalSort(options?: naturalSort.Options): (a: string | number, b: string | number) => number;
export = naturalSort;

````

### Additional Details
 * Last updated: Mon, 14 Oct 2024 19:07:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Antonio Morales](https://github.com/a-morales), and [Brian Crowell](https://github.com/fluggo).

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