Socket
Socket
Sign inDemoInstall

stable

Package Overview
Dependencies
0
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    stable

A stable array sort for JavaScript


Version published
Maintainers
1
Install size
6.03 kB
Created

Package description

What is stable?

The 'stable' npm package provides stable sorting algorithms. Stable sorting ensures that equal elements retain their relative order after sorting. This is important when sorting by multiple criteria, where the secondary sort should not disturb the order of the primary sort.

What are stable's main functionalities?

stable sorting

This feature allows you to sort an array of objects or values in a stable manner, meaning that the original order of equivalent elements is preserved. The code sample demonstrates sorting an array of objects by the 'age' property.

const stable = require('stable');
const arr = [{name: 'John', age: 45}, {name: 'Jane', age: 45}, {name: 'Joe', age: 30}];
const sortedByAge = stable(arr, (a, b) => a.age - b.age);

in-place stable sorting

This feature provides an in-place stable sort, which means the original array is sorted without creating a copy. The code sample demonstrates sorting an array of numbers in ascending order.

const stable = require('stable');
const arr = [3, 1, 4, 1, 5, 9];
stable.inplace(arr, (a, b) => a - b);

Other packages similar to stable

Readme

Source

Stable Build Status

A stable array sort, because Array#sort() is not guaranteed stable.

MIT licensed.

From the browser

Include stable.js or the minified version stable.min.js in your page, then call stable().

From Node.js

Install using NPM:

npm install stable

Require in your code:

var stable = require("stable");
Usage

The default sort is, as with Array#sort, lexicographical. Unlike Array#sort, sorting is NOT performed in-place.

stable(["foo", "bar", "baz"]);   // => ["bar", "baz", "foo"]
stable([10, 1, 5]);              // => [1, 10, 5]

A comparator function can be specified:

// Regular sort() compatible comparator, that returns a number.
// This demonstrates the default behavior.
function lexCmp(a, b) {
    return String(a).localeCompare(b);
}
stable(["foo", "bar", "baz"], lexCmp);   // => ["bar", "baz", "foo"]

// Boolean comparator. Sorts `b` before `a` if true.
// This demonstrates a simple way to sort numerically.
function greaterThan(a, b) {
    return a > b;
}
stable([10, 1, 5], greaterThan);  // -> [1, 5, 10]

FAQs

Last updated on 13 Jul 2012

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc