Class ComparatorFactory<T>

Defines various methods for constructing comparators.

Type Parameters

Index

Constructors

constructor

Methods

compare compareBy compareByDescending naturalOrder nullsFirst nullsLast reverseOrder

Constructors

constructor

new ComparatorFactory<T>(): ComparatorFactory<T>
Type Parameters
- T
Returns ComparatorFactory<T>
- Defined in ComparatorFactory.ts:7

Methods

compare

compare(comparison): Comparator<T>
Constructs a new comparator where values are ordered by the given comparison function.
Parameters
- comparison: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
Returns Comparator<T>
- Defined in ComparatorFactory.ts:17

compareBy

compareBy(selector): Comparator<T>
Constructs a new comparator where values are ordered by the natural ascending order of the property selected by the given selector function.
Parameters
- selector: ((value) => any)
  - - (value): any
    - Parameters
      value: T
      Returns any
Returns Comparator<T>
- Defined in ComparatorFactory.ts:28
compareBy(key): Comparator<T>
Constructs a new comparator where values are ordered by the natural ascending order of values for the given key.
Parameters
- key: keyof NonNullable<T>
Returns Comparator<T>
- Defined in ComparatorFactory.ts:37

compareByDescending

compareByDescending(selector): Comparator<T>
Constructs a new comparator where values are ordered by the natural descending order of the property selected by the given selector function.
Parameters
- selector: ((value) => any)
  - - (value): any
    - Parameters
      value: T
      Returns any
Returns Comparator<T>
- Defined in ComparatorFactory.ts:52
compareByDescending(key): Comparator<T>
Constructs a new comparator where values are ordered by the natural descending order of values for the given key.
Parameters
- key: keyof NonNullable<T>
Returns Comparator<T>
- Defined in ComparatorFactory.ts:61

naturalOrder

naturalOrder(): Comparator<T>
Constructs a new comparator where values are ordered naturally.

Returns Comparator<T>
- Defined in ComparatorFactory.ts:74

nullsFirst

nullsFirst(): Comparator<T>
Constructs a new comparator where null values are ordered at the beginning.

Returns Comparator<T>
- Defined in ComparatorFactory.ts:92

nullsLast

nullsLast(): Comparator<T>
Constructs a new comparator where null values are ordered at the end.

Returns Comparator<T>
- Defined in ComparatorFactory.ts:101

reverseOrder

reverseOrder(): Comparator<T>
Constructs a new comparator where values are ordered in reverse natural order.

Returns Comparator<T>
- Defined in ComparatorFactory.ts:83

Class ComparatorFactory<T>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns ComparatorFactory<T>

Methods

compare

Parameters

Parameters

Returns number

Returns Comparator<T>

compareBy

Parameters

Parameters

Returns any

Returns Comparator<T>

Parameters

Returns Comparator<T>

compareByDescending

Parameters

Parameters

Returns any

Returns Comparator<T>

Parameters

Returns Comparator<T>

naturalOrder

Returns Comparator<T>

nullsFirst

Returns Comparator<T>

nullsLast

Returns Comparator<T>

reverseOrder

Returns Comparator<T>

Settings

Member Visibility

Theme

On This Page