effect-io-ai

Package: effect
Module: Order

Order.alwaysEqual

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

See

Signature

declare const alwaysEqual: <A>() => Order<A>

Source

Since v4.0.0