Skip to main content Link Search Menu Expand Document (external link)
effect-extras

OrderX overview

Generic, framework-agnostic extensions to Effect’s Order module.

Added in v0.0.0

Table of contents

ordering

rankedEnum

Builds an Order.Order for an enum-like set of values from an explicit rank table, sorting each value by its assigned numeric rank.

Use it when a union of string (or other PropertyKey) literals has a natural priority that isn’t its alphabetical order — pass a record mapping every member to a rank and the resulting order sorts ascending by that rank.

Signature

export declare const rankedEnum: <const A extends PropertyKey>(ranks: Record<A, number>) => Order.Order<A>

Example

import { OrderX } from "@nunofyobiz/effect-extras"
import { Array } from "effect"

const byAge = OrderX.rankedEnum({ child: 0, parent: 1, grandparent: 2 })

assert.deepStrictEqual(Array.sort(["parent", "grandparent", "child"], byAge), ["child", "parent", "grandparent"])

Added in v0.0.0