<A>(): Order<A>Creates an Order that considers all values as equal.
When to use
Use when you need an order that treats all values as equal.
Details
Always returns 0 regardless of input values, making it useful as a neutral
element in order composition.
Example (Ordering with an always-equal Order)
import { Order } from "effect"
const alwaysEqualOrder = Order.alwaysEqual<number>()
console.log(alwaysEqualOrder(1, 2)) // 0
console.log(alwaysEqualOrder(2, 1)) // 0
console.log(alwaysEqualOrder(1, 1)) // 0export function function alwaysEqual<A>(): Order<A>Creates an Order that considers all values as equal.
When to use
Use when you need an order that treats all values as equal.
Details
Always returns 0 regardless of input values, making it useful as a neutral
element in order composition.
Example (Ordering with an always-equal Order)
import { Order } from "effect"
const alwaysEqualOrder = Order.alwaysEqual<number>()
console.log(alwaysEqualOrder(1, 2)) // 0
console.log(alwaysEqualOrder(2, 1)) // 0
console.log(alwaysEqualOrder(1, 1)) // 0
alwaysEqual<function (type parameter) A in alwaysEqual<A>(): Order<A>A>(): interface Order<in A>Represents a total ordering for values of type A.
When to use
Use when you need to define how values of a type are compared.
Details
An order returns -1 when the first value is less than the second, 0 when
the values are equal according to this ordering, and 1 when the first value
is greater than the second. It must satisfy total ordering laws: totality,
antisymmetry, and transitivity.
Example (Defining a custom Order)
import { Order } from "effect"
const byAge: Order.Order<{ name: string; age: number }> = (self, that) => {
if (self.age < that.age) return -1
if (self.age > that.age) return 1
return 0
}
const person1 = { name: "Alice", age: 30 }
const person2 = { name: "Bob", age: 25 }
console.log(byAge(person1, person2)) // 1
Order<function (type parameter) A in alwaysEqual<A>(): Order<A>A> {
return function make<A>(
compare: (self: A, that: A) => -1 | 0 | 1
): Order<A>
Creates a new Order instance from a comparison function.
When to use
Use when you need a sorting rule not covered by the built-in orders or input
mapping helpers, and you can provide a total comparison.
Details
Uses reference equality (===) as a shortcut: if self === that, it returns
0 without calling the comparison function. The comparison function should
return -1, 0, or 1, and the returned order satisfies total ordering
laws when the comparison function does.
Example (Creating an Order)
import { Order } from "effect"
const byAge = Order.make<{ name: string; age: number }>((self, that) => {
if (self.age < that.age) return -1
if (self.age > that.age) return 1
return 0
})
console.log(byAge({ name: "Alice", age: 30 }, { name: "Bob", age: 25 })) // 1
console.log(byAge({ name: "Alice", age: 25 }, { name: "Bob", age: 30 })) // -1
make(() => 0)
}