Function sortByFunction

sortByFunction<T>(array: T[], getKey: ((e: T) => string | number), dir?: SortDir): T[]
Sorts an array of objects by a function.

Returns
(a new) sorted array
Type Parameters
- T extends Record<string | symbol, any>
Parameters
- array: T[]
  
  an array to sort
- getKey: ((e: T) => string | number)
  
  a function returning the sort key for the given element
  - - (e: T): string | number
    - Parameters
      
      e: T
      
      Returns string | number
- dir: SortDir = "asc"
  
  the sort direction (default ascending)
Returns T[]
- Defined in src/arrays.ts:99

Generated using TypeDoc