# @magicdawn/finder-sort

> Sort file names in order meaningful for humans (inspired by OSX Finder)

Latest version **0.4.0** (published 2024-06-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install @magicdawn/finder-sort
pnpm add @magicdawn/finder-sort
yarn add @magicdawn/finder-sort
bun add @magicdawn/finder-sort
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2024-06-15 |
| First published | 2023-03-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tomasz Wegrzanowski |
| Maintainers | magicdawn |
| Keywords | sort, finder |

## Links

- npm: https://www.npmjs.com/package/@magicdawn/finder-sort
- Repository: https://github.com/magicdawn/finder-sort
- Homepage: https://github.com/magicdawn/finder-sort#readme
- Issues: https://github.com/magicdawn/finder-sort/issues
- npm.io page: https://npm.io/package/@magicdawn/finder-sort

## Recent versions

- 0.4.0 (latest) — 2024-06-15
- 0.3.4 — 2023-03-08

## README

## fork detail

- TypeScript
- `options.mapKey`
- `options.locale` the locale for `String.prototype.localeCompare`
- `options.folderFirst` put folder before normal file

---

Sort file names in order meaningful for humans (inspired by OSX Finder).

So `cat9.jpg` comes before `cat10.jpg`, it's case insensitive except as tie-breaker, is aware of multi-part paths and so on.

### Installation

```
    npm install finder-sort
```

### Usage

```
    import finderSort from "finder-sort";

    finderSort(arrayOfFiles);
```

For more complex scenacios, you can pass key function as second argument.
For example if you want to sort array of objects by their `fileName` property, you can do:

```
    import finderSort from "finder-sort";

    finderSort(arrayOfObjects, (obj) => obj.fileName);
```

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