effect-io-ai

Package: effect
Module: Order

Order.flip

Creates a new Order that reverses the comparison order of the input Order.

When to use

Use when you need the reverse of an existing order.

Details

Returns a new order that swaps the arguments before comparison. If the original order returns -1, the flipped order returns 1, and vice versa. Equal comparisons remain 0.

Example (Reversing an Order)

import { Order } from "effect"

const flip = Order.flip(Order.Number)

console.log(flip(1, 2)) // 1
console.log(flip(2, 1)) // -1
console.log(flip(1, 1)) // 0

See

• combine to combine orders for multi-criteria comparison

Signature

declare const flip: <A>(O: Order<A>) => Order<A>

Source

Since v4.0.0