API reference › @evolu/common › Order › Order

type Order<A> = (x: A, y: A) => Ordering;

Defined in: packages/common/src/Order.ts:21

Compares two values of type A and returns their ordering.

Ordering functions start with an 'order' prefix, e.g., orderNumber.

• Returns -1 if x is less than y.
• Returns 0 if x is equal to y.
• Returns 1 if x is greater than y.

An Order also defines equality. Use eqFromOrder to derive an Eq.