Class Comparator<T>

A Comparator defines a compare function enriched with methods to compose multiple comparators in order to form complex comparison behavior. A compare function returns negative numbers if the first value is lower than the second value, positive numbers if the first value is larger than the second value and zero if both values are equal.

Type Parameters

Index

Constructors

constructor

new Comparator<T>(compare): Comparator<T>
Type Parameters
- T
Parameters
- compare: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
Returns Comparator<T>
- Defined in Comparator.ts:10

Properties

`Readonly` compare

compare: ((a, b) => number)

Type declaration

- (a, b): number
- Parameters
  - a: T
  - b: T
  Returns number

Methods

reversed

reversed(): Comparator<T>
Reverses the order of the current comparator.

Returns Comparator<T>
- Defined in Comparator.ts:18

then

then(nextComparison): Comparator<T>
Composes the current comparator with the given comparison function such that the latter is applied for every equal values of the former comparator.
Parameters
- nextComparison: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
Returns Comparator<T>
- Defined in Comparator.ts:31

thenBy

thenBy(selector): Comparator<T>
Composes the current comparator with a comparator which compares the properties selected by the given selector function for every equal values of the current comparator.
Parameters
- selector: ((value) => any)
  - - (value): any
    - Parameters
      value: T
      Returns any
Returns Comparator<T>
- Defined in Comparator.ts:63
thenBy(key): Comparator<T>
Composes the current comparator with a comparator which compares the values of the given key for every equal values of the current comparator.
Parameters
- key: keyof NonNullable<T>
Returns Comparator<T>
- Defined in Comparator.ts:72

thenByDescending

thenByDescending(selector): Comparator<T>
Composes the current comparator with a comparator which compares the properties selected by the given selector function for every equal values of the current comparator in reverse (descending) order.
Parameters
- selector: ((value) => any)
  - - (value): any
    - Parameters
      value: T
      Returns any
Returns Comparator<T>
- Defined in Comparator.ts:86
thenByDescending(key): Comparator<T>
Composes the current comparator with a comparator which compares the values of the given key for every equal values of the current comparator in reverse (descending) order.
Parameters
- key: keyof NonNullable<T>
Returns Comparator<T>
- Defined in Comparator.ts:96

thenDescending

thenDescending(nextComparison): Comparator<T>
Composes the current comparator with the given comparison function such that the latter is applied for every equal values of the current comparator in reverse (descending) order.
Parameters
- nextComparison: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
Returns Comparator<T>
- Defined in Comparator.ts:50

`Static` naturalCompare

naturalCompare<T>(a, b, keyOrSelector?): number
Type Parameters
- T
Parameters
- a: T
- b: T
- Optional keyOrSelector: ((item) => any) | keyof NonNullable<T>
Returns number
- Defined in Comparator.ts:102

`Static` naturalOrder

naturalOrder<T>(): Comparator<T>
Type Parameters
- T
Returns Comparator<T>
- Defined in Comparator.ts:139

`Static` nullsFirst

nullsFirst<T>(): Comparator<T>
Type Parameters
- T
Returns Comparator<T>
- Defined in Comparator.ts:151

`Static` nullsLast

nullsLast<T>(): Comparator<T>
Type Parameters
- T
Returns Comparator<T>
- Defined in Comparator.ts:147

`Static` reverseOrder

reverseOrder<T>(): Comparator<T>
Type Parameters
- T
Returns Comparator<T>
- Defined in Comparator.ts:143

Class Comparator<T>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Parameters

Returns number

Returns Comparator<T>

Properties

Readonly compare

Type declaration

Parameters

Returns number

Methods

reversed

Returns Comparator<T>

then

Parameters

Parameters

Returns number

Returns Comparator<T>

thenBy

Parameters

Parameters

Returns any

Returns Comparator<T>

Parameters

Returns Comparator<T>

thenByDescending

Parameters

Parameters

Returns any

Returns Comparator<T>

Parameters

Returns Comparator<T>

thenDescending

Parameters

Parameters

Returns number

Returns Comparator<T>

Static naturalCompare

Type Parameters

Parameters

Returns number

Static naturalOrder

Type Parameters

Returns Comparator<T>

Static nullsFirst

Type Parameters

Returns Comparator<T>

Static nullsLast

Type Parameters

Returns Comparator<T>

Static reverseOrder

Type Parameters

Returns Comparator<T>

Settings

Member Visibility

Theme

On This Page

`Readonly` compare

`Static` naturalCompare

`Static` naturalOrder

`Static` nullsFirst

`Static` nullsLast

`Static` reverseOrder