Module cmp

Functionality for ordering and comparison.

Remarks

This module provides utilities for implementing equivalance relations and total orders, as well as ordering and comparing values.

Importing from this module

It is recommended to import items from this module individually:

import { Eq, Ord, Ordering, Reverse, clamp, cmp, eq, ge, gt, icmp, icmpBy,
         ieq, ieqBy, le, lt, max, min, ne } from "@neotype/prelude/cmp.js";
Copy

Implementing equivalence relations and total orders

• The Eq<T> and Ord<T> interfaces provide contracts for implementing equivalence relations and total orders, respectively. See their respective documentation for implementation patterns.
• The Eq:namespace and Ord:namespace companion namespaces provide the unique symbols required to implement their associated interfaces.