# alpha-sort

> Alphabetically sort an array of strings

Latest version **5.0.0** (published 2021-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install alpha-sort
pnpm add alpha-sort
yarn add alpha-sort
bun add alpha-sort
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2021-04-09 |
| First published | 2015-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=12 |
| Dependencies | 0 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | alpha, alphabet, alphabetically, lexicographically, sort, compare, comparator, order, locale, unicode, string, intl, collator, natural |

## Links

- npm: https://www.npmjs.com/package/alpha-sort
- Repository: https://github.com/sindresorhus/alpha-sort
- Homepage: https://github.com/sindresorhus/alpha-sort#readme
- Issues: https://github.com/sindresorhus/alpha-sort/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/alpha-sort

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2021-04-09
- 4.0.0 — 2020-12-30
- 3.1.0 — 2020-05-07
- 3.0.0 — 2019-04-23
- 2.0.1 — 2017-04-05
- 2.0.0 — 2016-12-17
- 1.0.2 — 2015-03-14
- 1.0.1 — 2015-01-19
- 1.0.0 — 2015-01-07

## README

# alpha-sort

> Alphabetically sort an array of strings

With correct sorting of unicode characters. Supports [natural sort order](https://en.wikipedia.org/wiki/Natural_sort_order) with an option.

## Install

```
$ npm install alpha-sort
```

## Usage

```js
import alphaSort from 'alpha-sort';

['b', 'a', 'c'].sort(alphaSort());
//=> ['a', 'b', 'c']

['b', 'a', 'c'].sort(alphaSort({descending: true}));
//=> ['c', 'b', 'a']

['B', 'a', 'C'].sort(alphaSort({caseInsensitive: true}));
//=> ['a', 'B', 'C']

['file10.txt', 'file2.txt', 'file03.txt'].sort(alphaSort({natural: true}));
//=> ['file2.txt', 'file03.txt', 'file10.txt']
```

## API

### alphaSort(options?)

Get a comparator function to be used as argument for [`Array#sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort).

#### options

Type: `object`

##### descending

Type: `boolean`\
Default: `false`

Whether or not to sort in descending order.

##### caseInsensitive

Type: `boolean`\
Default: `false`

Whether or not to sort case-insensitively.

Note: If two elements are considered equal in the case-insensitive comparison, the tie-break will be a standard (case-sensitive) comparison. Example:

```js
import alphaSort from 'alpha-sort';

['bar', 'baz', 'Baz'].sort(alphaSort({caseInsensitive: true}));
//=> ['bar', 'Baz', 'baz']
```

##### natural

Type: `boolean`\
Default: `false`

Whether or not to sort using [natural sort order](https://en.wikipedia.org/wiki/Natural_sort_order) (such as sorting `10` after `2`).

Note: If two elements are considered equal in the natural sort order comparison, the tie-break will be a standard (non-natural) comparison. Example:

```js
import alphaSort from 'alpha-sort';

['file10.txt', 'file05.txt', 'file0010.txt'].sort(alphaSort({natural: true}));
//=> ['file05.txt', 'file0010.txt', 'file10.txt']
```

##### preprocessor

Type: `function`\
Default: `undefined`

A custom function that you can provide to manipulate the elements before sorting. This does not modify the values of the array; it only interferes in the sorting order.

This can be used, for example, if you are sorting book titles in English and want to ignore common articles such as `the`, `a` or `an`:

```js
import alphaSort from 'alpha-sort';

['The Foo', 'Bar'].sort(alphaSort({
	preprocessor: title => title.replace(/^(?:the|a|an) /i, '')
}));
//=> ['Bar', 'The Foo']
```

Note: If two elements are considered equal when sorting with a custom preprocessor, the tie-break will be a comparison without the custom preprocessor.

## Related

- [num-sort](https://github.com/sindresorhus/num-sort) - Sort an array of numbers

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