npm.io
0.4.0 • Published 2 years ago

@magicdawn/finder-sort

Licence
ISC
Version
0.4.0
Deps
0
Size
5 kB
Vulns
0
Weekly
0

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);

Keywords