diff options
| author | Florian Dold <florian.dold@gmail.com> | 2017-08-14 05:01:11 +0200 |
|---|---|---|
| committer | Florian Dold <florian.dold@gmail.com> | 2017-08-14 05:02:09 +0200 |
| commit | 363723fc84f7b8477592e0105aeb331ec9a017af (patch) | |
| tree | 29f92724f34131bac64d6a318dd7e30612e631c7 /node_modules/natural-compare/README.md | |
| parent | 5634e77ad96bfe1818f6b6ee70b7379652e5487f (diff) | |
node_modules
Diffstat (limited to 'node_modules/natural-compare/README.md')
| -rw-r--r-- | node_modules/natural-compare/README.md | 125 |
1 files changed, 0 insertions, 125 deletions
diff --git a/node_modules/natural-compare/README.md b/node_modules/natural-compare/README.md deleted file mode 100644 index c85dfdf98..000000000 --- a/node_modules/natural-compare/README.md +++ /dev/null @@ -1,125 +0,0 @@ - -[Build]: http://img.shields.io/travis/litejs/natural-compare-lite.png -[Coverage]: http://img.shields.io/coveralls/litejs/natural-compare-lite.png -[1]: https://travis-ci.org/litejs/natural-compare-lite -[2]: https://coveralls.io/r/litejs/natural-compare-lite -[npm package]: https://npmjs.org/package/natural-compare-lite -[GitHub repo]: https://github.com/litejs/natural-compare-lite - - - - @version 1.4.0 - @date 2015-10-26 - @stability 3 - Stable - - -Natural Compare – [![Build][]][1] [![Coverage][]][2] -=============== - -Compare strings containing a mix of letters and numbers -in the way a human being would in sort order. -This is described as a "natural ordering". - -```text -Standard sorting: Natural order sorting: - img1.png img1.png - img10.png img2.png - img12.png img10.png - img2.png img12.png -``` - -String.naturalCompare returns a number indicating -whether a reference string comes before or after or is the same -as the given string in sort order. -Use it with builtin sort() function. - - - -### Installation - -- In browser - -```html -<script src=min.natural-compare.js></script> -``` - -- In node.js: `npm install natural-compare-lite` - -```javascript -require("natural-compare-lite") -``` - -### Usage - -```javascript -// Simple case sensitive example -var a = ["z1.doc", "z10.doc", "z17.doc", "z2.doc", "z23.doc", "z3.doc"]; -a.sort(String.naturalCompare); -// ["z1.doc", "z2.doc", "z3.doc", "z10.doc", "z17.doc", "z23.doc"] - -// Use wrapper function for case insensitivity -a.sort(function(a, b){ - return String.naturalCompare(a.toLowerCase(), b.toLowerCase()); -}) - -// In most cases we want to sort an array of objects -var a = [ {"street":"350 5th Ave", "room":"A-1021"} - , {"street":"350 5th Ave", "room":"A-21046-b"} ]; - -// sort by street, then by room -a.sort(function(a, b){ - return String.naturalCompare(a.street, b.street) || String.naturalCompare(a.room, b.room); -}) - -// When text transformation is needed (eg toLowerCase()), -// it is best for performance to keep -// transformed key in that object. -// There are no need to do text transformation -// on each comparision when sorting. -var a = [ {"make":"Audi", "model":"A6"} - , {"make":"Kia", "model":"Rio"} ]; - -// sort by make, then by model -a.map(function(car){ - car.sort_key = (car.make + " " + car.model).toLowerCase(); -}) -a.sort(function(a, b){ - return String.naturalCompare(a.sort_key, b.sort_key); -}) -``` - -- Works well with dates in ISO format eg "Rev 2012-07-26.doc". - - -### Custom alphabet - -It is possible to configure a custom alphabet -to achieve a desired order. - -```javascript -// Estonian alphabet -String.alphabet = "ABDEFGHIJKLMNOPRSŠZŽTUVÕÄÖÜXYabdefghijklmnoprsšzžtuvõäöüxy" -["t", "z", "x", "õ"].sort(String.naturalCompare) -// ["z", "t", "õ", "x"] - -// Russian alphabet -String.alphabet = "АБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯабвгдеёжзийклмнопрстуфхцчшщъыьэюя" -["Ё", "А", "Б"].sort(String.naturalCompare) -// ["А", "Б", "Ё"] -``` - - -External links --------------- - -- [GitHub repo][https://github.com/litejs/natural-compare-lite] -- [jsperf test](http://jsperf.com/natural-sort-2/12) - - -Licence -------- - -Copyright (c) 2012-2015 Lauri Rooden <lauri@rooden.ee> -[The MIT License](http://lauri.rooden.ee/mit-license.txt) - - |
