webshrine / stdtyp/src / CompareResultValue

Type Alias: CompareResultValue

CompareResultValue: -1 | 0 | 1

Used for define return values for comparator functions, that usually used in Array.prototype.sort method

Return rules:

• a < b = -1
• a > b = 1
• a = b = 0

See

CompareFn

Example

function compare(a: number, b: number): CompareResultValue { ... }
const sorted = [3,1,2].sort(compare)

Defined in

packages/stdtyp/src/aliases/index.ts:53