Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "keys"

Index

Functions

Functions

compareByKey

  • compareByKey<T, A>(a: A, cmp?: Comparator<Val1<T, A>>): Comparator<T>
  • compareByKey<T, A>(a: Fn<T, A>, cmp?: Comparator<A>): Comparator<T>

  • HOF comparator. Returns new comparator to sort objects by given key and with optional comparator cmp (default: compare).

    Type parameters

    • T

    • A: Keys<T>

    Parameters

    • a: A
    • Optional cmp: Comparator<Val1<T, A>>

      -

    Returns Comparator<T>

  • Type parameters

    • T

    • A

    Parameters

    • a: Fn<T, A>
    • Optional cmp: Comparator<A>

    Returns Comparator<T>

compareByKeys2

  • compareByKeys2<T, A, B>(major: A, minor: B, cmpA?: Comparator<Val1<T, A>>, cmpB?: Comparator<Val1<T, B>>): Comparator<T>
  • compareByKeys2<T, A, B>(major: Fn<T, A>, minor: Fn<T, B>, cmpA?: Comparator<A>, cmpB?: Comparator<B>): Comparator<T>

  • HOF comparator. Returns new comparator to sort objects by given keys a (major), b (minor) and with optional comparators (default for each: compare).

    Type parameters

    • T

    • A: Keys<T>

    • B: Keys<T>

    Parameters

    • major: A
    • minor: B
    • Optional cmpA: Comparator<Val1<T, A>>

      -

    • Optional cmpB: Comparator<Val1<T, B>>

      -

    Returns Comparator<T>

  • Type parameters

    • T

    • A

    • B

    Parameters

    • major: Fn<T, A>
    • minor: Fn<T, B>
    • Optional cmpA: Comparator<A>
    • Optional cmpB: Comparator<B>

    Returns Comparator<T>

compareByKeys3

  • compareByKeys3<T, A, B, C>(major: A, minor: B, patch: B, cmpA?: Comparator<Val1<T, A>>, cmpB?: Comparator<Val1<T, B>>, cmpC?: Comparator<Val1<T, C>>): Comparator<T>
  • compareByKeys3<T, A, B, C>(major: Fn<T, A>, minor: Fn<T, B>, patch: Fn<T, C>, cmpA?: Comparator<A>, cmpB?: Comparator<B>, cmpC?: Comparator<C>): Comparator<T>

  • Same as compareByKeys2, but for 3 sort keys / comparators.

    Type parameters

    • T

    • A: Keys<T>

    • B: Keys<T>

    • C: Keys<T>

    Parameters

    • major: A
    • minor: B
    • patch: B
    • Optional cmpA: Comparator<Val1<T, A>>

      -

    • Optional cmpB: Comparator<Val1<T, B>>

      -

    • Optional cmpC: Comparator<Val1<T, C>>

      -

    Returns Comparator<T>

  • Type parameters

    • T

    • A

    • B

    • C

    Parameters

    • major: Fn<T, A>
    • minor: Fn<T, B>
    • patch: Fn<T, C>
    • Optional cmpA: Comparator<A>
    • Optional cmpB: Comparator<B>
    • Optional cmpC: Comparator<C>

    Returns Comparator<T>

compareByKeys4

  • compareByKeys4<T, A, B, C, D>(a: A, b: B, c: C, d: D, cmpA?: Comparator<Val1<T, A>>, cmpB?: Comparator<Val1<T, B>>, cmpC?: Comparator<Val1<T, C>>, cmpD?: Comparator<Val1<T, D>>): Comparator<T>
  • compareByKeys4<T, A, B, C, D>(a: Fn<T, A>, b: Fn<T, B>, c: Fn<T, C>, d: Fn<T, D>, cmpA?: Comparator<A>, cmpB?: Comparator<B>, cmpC?: Comparator<C>, cmpD?: Comparator<D>): Comparator<T>

  • Same as compareByKeys2, but for 4 sort keys / comparators.

    Type parameters

    • T

    • A: Keys<T>

    • B: Keys<T>

    • C: Keys<T>

    • D: Keys<T>

    Parameters

    • a: A

      -

    • b: B

      -

    • c: C

      -

    • d: D

      -

    • Optional cmpA: Comparator<Val1<T, A>>

      -

    • Optional cmpB: Comparator<Val1<T, B>>

      -

    • Optional cmpC: Comparator<Val1<T, C>>

      -

    • Optional cmpD: Comparator<Val1<T, D>>

      -

    Returns Comparator<T>

  • Type parameters

    • T

    • A

    • B

    • C

    • D

    Parameters

    • a: Fn<T, A>
    • b: Fn<T, B>
    • c: Fn<T, C>
    • d: Fn<T, D>
    • Optional cmpA: Comparator<A>
    • Optional cmpB: Comparator<B>
    • Optional cmpC: Comparator<C>
    • Optional cmpD: Comparator<D>

    Returns Comparator<T>

Const getKey

  • getKey(k: string | Fn<any, any>): Fn<any, any>

  • Parameters

    • k: string | Fn<any, any>

    Returns Fn<any, any>

Generated using TypeDoc