sort-array-by-key
v0.0.2
Published
A Typescript helper function to sort a typed array of objects by a specified element key
Downloads
5
Readme
sort-array-by-key
Sort a typed array of objects by a specified element key in Typescript/JS (ES6)
Installation
npm install sort-array-by-key --save
or
yarn add sort-array-by-key
Syntax
sortArrayByKey<T>(arr:T[]);
Parameters
arr
: Required typed Array value of typeT[]
. Type defaults toRecord<any, any>
.key
: Required value of typekeyof T
, upon which the items in the array are sorted by their corresponding values.ascending
: Optional value of typeboolean
. Determines whether the elements of thearr
value are sorted in ascending order. Defaults to true
Return value
sortArrayByKey
will return a reference to the originalarr
array, of typeT[]
, sorted bykey
values.
Usage
Import the sortArrayByKey
function
import sortArrayByKey from "sort-array-by-key";
or
const sortArrayByKey = require("sort-array-by-key")
Sample implementation
type User = {
name: string;
age: number;
};
const userList: User[] = [
{ name: 'Sally', age: 43 },
{ name: 'Wally', age: 13 },
{ name: 'Hally', age: 73 },
{ name: 'Cally', age: 23 },
];
// returns
/**
[
{ name: 'Wally', age: 13 },
{ name: 'Cally', age: 23 },
{ name: 'Sally', age: 43 },
{ name: 'Hally', age: 73 },
]
*/
const sortedUserList = sortArrayByKey<User>(userList, 'age');