@rws-air/utils
Version:
Utilities for rws-air libraries and applications
31 lines • 980 B
TypeScript
/**
* 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 declare function stableTableSort<T>(array: T[], orderBy: keyof T, order: TableOrder, headerMapping: Map<keyof T, string>): T[];
export declare type TableOrder = 'desc' | 'asc';
//# sourceMappingURL=StableTableSort.d.ts.map