Installations

npm install natural-compare-lite

Pull Requests

Open

0

Total

5

Closed

2

Merged

3

Issues

Open

0

Total

8

Closed

8

Releases

Unable to fetch releases

Contributors

4

View all 4 contributors

Developer

litejs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

4.1.0

NPM Version

3.3.3 Statistics

109 Stars

60 Commits

8 Forks

6 Watching

2 Branches

4 Contributors

Updated on 20 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,024,282,388

Last day

-7.5%

1,740,865

Compared to previous day

Last week

1.5%

10,164,160

Compared to previous week

Last month

10.1%

41,981,840

Compared to previous month

Last year

-2.1%

489,471,730

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

2

buildman testman

Versions

Natural Compare –

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".

1Standard sorting:   Natural order sorting:
2    img1.png            img1.png
3    img10.png           img2.png
4    img12.png           img10.png
5    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

1<script src=natural-compare.js></script>

In node.js: npm install natural-compare-lite

1var naturalCompare = require("natural-compare-lite")

Usage

1// Simple case sensitive example
2var a = ["z1.doc", "z10.doc", "z17.doc", "z2.doc", "z23.doc", "z3.doc"];
3a.sort(String.naturalCompare);
4// ["z1.doc", "z2.doc", "z3.doc", "z10.doc", "z17.doc", "z23.doc"]
5
6// Use wrapper function for case insensitivity
7a.sort(function(a, b){
8  return String.naturalCompare(a.toLowerCase(), b.toLowerCase());
9})
10
11// In most cases we want to sort an array of objects
12var a = [ {"street":"350 5th Ave", "room":"A-1021"}
13        , {"street":"350 5th Ave", "room":"A-21046-b"} ];
14
15// sort by street, then by room
16a.sort(function(a, b){
17  return String.naturalCompare(a.street, b.street) || String.naturalCompare(a.room, b.room);
18})
19
20// When text transformation is needed (eg toLowerCase()),
21// it is best for performance to keep
22// transformed key in that object.
23// There are no need to do text transformation
24// on each comparison when sorting.
25var a = [ {"make":"Audi", "model":"A6"}
26        , {"make":"Kia",  "model":"Rio"} ];
27
28// sort by make, then by model
29a.map(function(car){
30  car.sort_key = (car.make + " " + car.model).toLowerCase();
31})
32a.sort(function(a, b){
33  return String.naturalCompare(a.sort_key, b.sort_key);
34})

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.

1// Estonian alphabet
2String.alphabet = "ABDEFGHIJKLMNOPRSŠZŽTUVÕÄÖÜXYabdefghijklmnoprsšzžtuvõäöüxy"
3["t", "z", "x", "õ"].sort(String.naturalCompare)
4// ["z", "t", "õ", "x"]
5
6// Russian alphabet
7String.alphabet = "АБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯабвгдеёжзийклмнопрстуфхцчшщъыьэюя"
8["Ё", "А", "Б"].sort(String.naturalCompare)
9// ["А", "Б", "Ё"]

External links

GitHub repo | npm package

Licence

Copyright (c) 2012-2022 Lauri Rooden <lauri@rooden.ee>
The MIT License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

1

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More