sort-sheet

Useful to sort an array like a spreadsheet.

Install

$ npm install sort-sheet

Usage

const sortSheet = require("sort-sheet");
 
sortSheet([
 { k1: "a", k2: 6, k3: "foo" },
 { k1: "b", k2: 7, k3: "bar" },
 { k1: "a", k2: 6, k3: "baz" },
 { k1: "a", k2: 9, k3: "rab" },
 { k1: "b", k2: 5, k3: "zab" },
 { k1: "a", k2: 6, k3: "foo" },
], [
 { orderBy: "asc", sortBy: "k1" }, // Sort by
 { orderBy: "desc", sortBy: "k2" }, // Then by
 { orderBy: "asc", sortBy: "k3" }, // Then by
]);
/*
[
 { k1: "a", k2: 9, k3: "rab" },
 { k1: "a", k2: 6, k3: "baz" },
 { k1: "a", k2: 6, k3: "foo" },
 { k1: "a", k2: 6, k3: "foo" },
 { k1: "b", k2: 7, k3: "bar" },
 { k1: "b", k2: 5, k3: "zab" },
]
*/
 
sortSheet([{ k1: { k2: "t" } }, { k1: { k2: "r" } }, { k1: { k2: "s" } }], [
 { orderBy: "asc", sortBy: "k1.k2" }
]);
//=> [{ k1: { k2: "r" } }, { k1: { k2: "s" }, { k1: { k2: "t" } } }]
 
sortSheet([{ k1: "w" }, { k1: "e" }, { k1: "v" }], [
 { orderBy: (a, b) => a.localeCompare(b), sortBy: "k1" }, // Sort by
]);
//=> [{ k1: "e" }, { k1: "v" }, { k1: "w" }]
 
sortSheet([{ k1: Array(3).fill("bar") }, { k1: Array(2).fill("baz") }], [
 { orderBy: (a, b) => a.length - b.length, sortBy: "k1" }, // Sort by
]);
//=> [{ k1: [ "baz", "baz" ] }, { k1: [ "bar", "bar", "bar" ] }]

API

sortSheet(array, options?)

Returns a new sorted array.

array

Type: Array

options

Type: Option[]

interface Option {
 orderBy?: "asc" | "desc" | Function;
 sortBy: string;
}

orderBy function