Class default<T>

Type Parameters

T

Hierarchy

default

Implements

IComparer<T>
IEqualityComparer<T>

Index

Constructors

Properties

#comparer? #equalityComparer?

Methods

compare equals greaterThan greaterThanOrEqual lessThan lessThanOrEqual

Constructors

constructor

new default<T>(comparer?, equalityComparer?): default<T>
Type Parameters
- T
Parameters
- Optional comparer: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: T
      b: T
      Returns number
- Optional equalityComparer: ((x, y) => boolean)
  - - (x, y): boolean
    - Parameters
      x: T
      y: T
      Returns boolean
Returns default<T>
- Defined in src/Comparers/CustomComparer.ts:11

Properties

`Private` `Optional` `Readonly` #comparer

#comparer?: ((a, b) => number)

Type declaration

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

`Private` `Optional` `Readonly` #equalityComparer

#equalityComparer?: ((x, y) => boolean)

Type declaration

- (x, y): boolean
- Parameters
  - x: T
  - y: T
  Returns boolean

Methods

compare

compare(x, y): number
Compares 'x' to 'y' where the following rules apply;
- x < y : return <0
- x == y : return 0
- x > y : return >0
Parameters
- x: T
- y: T
Returns number
Implementation of IComparer.compare
- Defined in src/Comparers/CustomComparer.ts:21

equals

equals(x, y): boolean
Returns true if 'x' is equal to 'y'.
Parameters
- x: T
- y: T
Returns boolean
Implementation of IEqualityComparer.equals
- Defined in src/Comparers/CustomComparer.ts:33

greaterThan

greaterThan(x, y): boolean
Returns true if 'x' is greater than 'y'.
Parameters
- x: T
- y: T
Returns boolean
Implementation of IComparer.greaterThan
- Defined in src/Comparers/CustomComparer.ts:45

greaterThanOrEqual

greaterThanOrEqual(x, y): boolean
Returns true if 'x' is greater than or equal to 'y'.
Parameters
- x: T
- y: T
Returns boolean
Implementation of IComparer.greaterThanOrEqual
- Defined in src/Comparers/CustomComparer.ts:50

lessThan

lessThan(x, y): boolean
Returns true if 'x' is les than 'y'.
Parameters
- x: T
- y: T
Returns boolean
Implementation of IComparer.lessThan
- Defined in src/Comparers/CustomComparer.ts:55

lessThanOrEqual

lessThanOrEqual(x, y): boolean
Returns true if 'x' is less than or equal to 'y'.
Parameters
- x: T
- y: T
Returns boolean
Implementation of IComparer.lessThanOrEqual
- Defined in src/Comparers/CustomComparer.ts:60

Generated using TypeDoc