Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Sort

Functions to be used in {@link Array.prototype.sort} as a callback.

see

https://pavel-surinin.github.io/declarativejs/#/?id=sorters

Index

Functions

ascendingBy

  • ascendingBy<T>(...getters: ((val: T) => AutoComparable)[]): (a: T, b: T) => number
  • ascendingBy<T, K>(...keys: K[]): (a: T, b: T) => number
  • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in ascending order by values provided from callbacks. First callback has highest priority in sorting and so on. It accepts as many callbacks as You need.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=ascendingby

    Type parameters

    • T

    Parameters

    • Rest ...getters: ((val: T) => AutoComparable)[]

      functions to get values to be compared

    Returns (a: T, b: T) => number

    a closure that can be used in array.sort() function

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in ascending order by values provided from callbacks. First callback has highest priority in sorting and so on. It accepts as many callbacks as You need.

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=ascendingby

        Parameters

        • a: T
        • b: T

        Returns number

        a closure that can be used in array.sort() function

  • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in ascending order by values resolved from object keys passed as parameter. First key has highest priority in sorting and so on. It accepts as many keys as You need.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=ascendingby

    Type parameters

    • T

    • K: string | number | symbol

    Parameters

    • Rest ...keys: K[]

      functions to get values to be compared

    Returns (a: T, b: T) => number

    a closure that can be used in array.sort() function

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in ascending order by values resolved from object keys passed as parameter. First key has highest priority in sorting and so on. It accepts as many keys as You need.

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=ascendingby

        Parameters

        • a: T
        • b: T

        Returns number

        a closure that can be used in array.sort() function

by

  • by<T>(...conditions: SortingCondition<T, any>[]): (a: T, b: T) => number
  • by<T, K>(key: K, values: T[K][]): (a: T, b: T) => number
  • Functions to be used in {@link Array.prototype.sort} as a callback. Function that will sort items in array with custom values, by provided order. It accepts as a parameter object with valueToOrderElement mapper and array of custom order rule

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=by

    Type parameters

    • T

    Parameters

    Returns (a: T, b: T) => number

    comparator for Array.prototype.sort function.

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. Function that will sort items in array with custom values, by provided order. It accepts as a parameter object with valueToOrderElement mapper and array of custom order rule

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=by

        Parameters

        • a: T
        • b: T

        Returns number

        comparator for Array.prototype.sort function.

  • Functions to be used in {@link Array.prototype.sort} as a callback. Function that will sort items in array with custom values, by provided order.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=by

    Type parameters

    • T

    • K: string | number | symbol

    Parameters

    • key: K

      object key to extract value. This value will be compared to another

    • values: T[K][]

      values that will be define order of extracted value by key

    Returns (a: T, b: T) => number

    comparator for Array.prototype.sort function.

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. Function that will sort items in array with custom values, by provided order.

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=by

        Parameters

        • a: T
        • b: T

        Returns number

        comparator for Array.prototype.sort function.

descendingBy

  • descendingBy<T>(...getters: ((val: T) => AutoComparable)[]): (a: T, b: T) => number
  • descendingBy<T, K>(...keys: K[]): (a: T, b: T) => number
  • Functions to be used in {@link Array.prototype.sort} as a callback. * Sorts array in descending order by values provided from callbacks. First callback has highest priority in sorting and so on. It accepts as many callbacks as You need.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=descendingby

    Type parameters

    • T

    Parameters

    • Rest ...getters: ((val: T) => AutoComparable)[]

      functions to get values to be compared

    Returns (a: T, b: T) => number

    a closure that can be used in array.sort() function

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. * Sorts array in descending order by values provided from callbacks. First callback has highest priority in sorting and so on. It accepts as many callbacks as You need.

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=descendingby

        Parameters

        • a: T
        • b: T

        Returns number

        a closure that can be used in array.sort() function

  • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in descending order by values resolved from object keys passed as parameter. First key has highest priority in sorting and so on. It accepts as many keys as You need.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=descendingby

    Type parameters

    • T

    • K: string | number | symbol

    Parameters

    • Rest ...keys: K[]

      functions to get values to be compared

    Returns (a: T, b: T) => number

    a closure that can be used in array.sort() function

      • (a: T, b: T): number
      • Functions to be used in {@link Array.prototype.sort} as a callback. Sorts array in descending order by values resolved from object keys passed as parameter. First key has highest priority in sorting and so on. It accepts as many keys as You need.

        see

        https://pavel-surinin.github.io/declarativejs/#/?id=descendingby

        Parameters

        • a: T
        • b: T

        Returns number

        a closure that can be used in array.sort() function

orderedBy

  • orderedBy<T>(order: T[]): (a: T, b: T) => 0 | 1 | -1
  • Functions to be used in {@link Array.prototype.sort} as a callback. Function that will sort items in array, by provided order. It accepts as a parameter array of custom order rule. Element, that are not present in order array will be at he the end of the sorted list.

    see

    https://pavel-surinin.github.io/declarativejs/#/?id=orderedby

    Type parameters

    • T

    Parameters

    • order: T[]

      array of custom order of items that are being sorted.

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

    comparator for Array.prototype.sort function.

      • (a: T, b: T): 0 | 1 | -1
      • Parameters

        • a: T
        • b: T

        Returns 0 | 1 | -1

Generated using TypeDoc