Function: compareFunc()

compareFunc<T>(): Arbitrary<(a, b) => number>

Defined in: packages/fast-check/src/arbitrary/compareFunc.ts:21

For comparison functions

A comparison function returns:

• negative value whenever a < b
• positive value whenever a > b
• zero whenever a and b are equivalent

Comparison functions are transitive: a < b and b < c => a < c

They also satisfy: a < b <=> b > a and a = b <=> b = a

Type Parameters

Type Parameter
T

Returns

Arbitrary<(a, b) => number>

Remarks

Since 1.6.0