An open API service indexing awesome lists of open source software.

https://github.com/discoveryjs/natural-compare

Compare strings in a natural order
https://github.com/discoveryjs/natural-compare

Last synced: 12 months ago
JSON representation

Compare strings in a natural order

Awesome Lists containing this project

README

          

[![NPM version](https://img.shields.io/npm/v/@discoveryjs/natural-compare.svg)](https://www.npmjs.com/package/@discoveryjs/natural-compare)
[![Build Status](https://github.com/discoveryjs/natural-compare/actions/workflows/build.yml/badge.svg)](https://github.com/discoveryjs/natural-compare/actions/workflows/build.yml)
[![Coverage Status](https://coveralls.io/repos/github/discoveryjs/natural-compare/badge.svg?branch=main)](https://coveralls.io/github/discoveryjs/natural-compare?branch=main)
[![Minified size](https://badgen.net/bundlephobia/min/@discoveryjs/natural-compare)](https://bundlephobia.com/result?p=@discoveryjs/natural-compare)
[![Minified + gzip size](https://badgen.net/bundlephobia/minzip/@discoveryjs/natural-compare)](https://bundlephobia.com/result?p=@discoveryjs/natural-compare)

# @discoveryjs/natural-compare

Compare strings in a natural order

## Install

```
npm install @discoveryjs/natural-compare
```

## Usage

```js
import { naturalCompare } from '@discoveryjs/natural-compare';

[
'file10.js',
'file1.js',
'file2.js',
'file12.js',
'file9.js'
].sort(naturalCompare);
// file1.js
// file2.js
// file9.js
// file10.js
// file12.js

// standart sorting
[
'file10.js',
'file1.js',
'file2.js',
'file12.js',
'file9.js'
].sort();
// file1.js
// file10.js
// file12.js
// file2.js
// file9.js
```

In browser:

```html


import { natualCompare } from "@discoveryjs/natural-compare/dist/natural-compare.esm.js";

array.sort(naturalCompare);




array.sort(naturalCompare);

```

## License

MIT