/
StableTableSort.ts
42 lines (39 loc) · 1.04 KB
/
StableTableSort.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import sort from 'lodash.orderby';
/**
* Stabily sorts an array of objects using lodash.orderby
* @param array Array of objects to order
* @param orderBy Key to order by
* @param order Order ascending or descending
* @param headerMapping Mapping of table headers for sorting on nested properties
* @example
* ```typescript
* interface ArrType {
* key: string;
* prop: string;
* }
*
* const arr: ArrType[] = [
* { key: '1', prop: '2' },
* { key: '4', prop: '4' }
* ];
*
* const mappings: Map<keyof ArrType, string> = new Map(
* [
* [ 'key', ((type: ArrType) => type.key.toString()) as unknown as string ],
* [ 'prop', ((type: ArrType) => type.prop) as unknown as string ]
* ]
* );
*
* stableTableSort(arr, 'key', 'asc', mappings);
* ```
*/
export function stableTableSort<T>(
array: T[],
orderBy: keyof T,
order: TableOrder,
headerMapping: Map<keyof T, string>
) {
const orderValue = headerMapping.get(orderBy);
return sort(array, [orderValue], [order]) as T[];
}
export type TableOrder = 'desc' | 'asc';