Function sortBy

Returns a function that can be used as a callback to .sort() method. Returned function will sort array by given property.

  • sortBy<T extends Record<string | number | symbol, any>>(
        propertyName: keyof T,
        asc?: boolean,
        defaultValue?: unknown,
    ): (a: T, b: T) => -1 | 0 | 1

  • Type Parameters

    • T extends Record<string | number | symbol, any>

    Parameters

    • propertyName: keyof T

      name of the property to sort by

    • asc: boolean = true

      should sort be ascending?

    • defaultValue: unknown = null

      value to use when property is not defined in one of the objects

    Returns (a: T, b: T) => -1 | 0 | 1

Settings

Member Visibility