interface Comp<K>

An object providing methods to compare two values of type K.

Companion namespace: Comp

Type parameters

Name	Description
K	the value type

Methods

compare

Returns 0 if given value1 and value2 are equal, a positive value is value1 is greater than value2, and a negative value otherwise.

Definition

compare(value1: K, value2: K): number;

Parameters

Name	Type	Description
value1	K	the first value to compare
value2	K	the seconds value to compare

example

const c = Comp.numberComp()
console.log(c.compare(5, 5))
// => 0
console.log(c.compare(3, 5))
// => -2
console.log(c.compare(5, 3))
// => 2

isComparable

Returns true if this instance can compare given obj.

Definition

isComparable(obj: any): obj is K;

Parameters

Name	Type	Description
obj	any	the object to check

example

const c = Comp.numberComp()
console.log(c.isComparable(5))
// => true
console.log(c.isComparable('a'))
// => false