effect-io-ai

Package: effect
Module: Option

Option.makeOrder

Creates an Order for Option<A> from an Order for A.

When to use

Use when you need to sort Some and None values, with None ordered before present values and present values compared by a supplied ordering rule.

Details

• None is considered less than any Some
• Two Some values are compared using the provided Order
• Two None values are equal (returns 0)

Example (Ordering Options)

import { Number as N, Option } from "effect"

const ord = Option.makeOrder(N.Order)

console.log(ord(Option.none(), Option.some(1)))
// Output: -1

console.log(ord(Option.some(1), Option.none()))
// Output: 1

console.log(ord(Option.some(1), Option.some(2)))
// Output: -1

Signature

declare const makeOrder: <A>(O: Order<A>) => Order<Option<A>>

Source

Since v4.0.0