Interface IComparer<T>

Type Parameters

T

Hierarchy

IComparer

Implemented by

Index

Methods

compare equals greaterThan greaterThanOrEqual lessThan lessThanOrEqual

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
- Defined in src/Comparers/_types.ts:17

equals

equals(x, y): boolean
Returns true if 'x' is equal to 'y'.
Parameters
- x: T
- y: T
Returns boolean
- Defined in src/Comparers/_types.ts:22

greaterThan

greaterThan(x, y): boolean
Returns true if 'x' is greater than 'y'.
Parameters
- x: T
- y: T
Returns boolean
- Defined in src/Comparers/_types.ts:27

greaterThanOrEqual

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

lessThan

lessThan(x, y): boolean
Returns true if 'x' is les than 'y'.
Parameters
- x: T
- y: T
Returns boolean
- Defined in src/Comparers/_types.ts:37

lessThanOrEqual

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

Generated using TypeDoc