@thi.ng/compare/compare.d.ts

Comparators with support for types implementing the @thi.ng/api/ICompare interface

/**
 * Generic comparator (for arbitrary types) with support for
 * [ICompare](https://docs.thi.ng/umbrella/api/interfaces/ICompare.html)
 * implementations and using the rules described below. Returns standard
 * comparator result, i.e. a negative value if `a < b`, a positive value if `a >
 * b` and zero otherwise.
 *
 * @remarks
 * Special handling for the following case, in the given order:
 *
 * `a === b` => 0
 *
 * | a        | b        | result        |
 * |----------|----------|--------------:|
 * | null     | null     | 0             |
 * | null     | non-null | -1            |
 * | non-null | null     | 1             |
 * | ICompare | any      | a.compare(b)  |
 * | any      | ICompare | -b.compare(a) |
 *
 * Note: `null` here also includes `undefined`
 *
 * @param a
 * @param b
 * @returns
 */
export declare const compare: (a: any, b: any) => number;
//# sourceMappingURL=compare.d.ts.map