effect-io-ai

Package: effect
Module: DateTime

DateTime.Order

Provides an Order for comparing and sorting DateTime values.

Details

DateTime values are ordered by their epoch milliseconds, so earlier times come before later times regardless of time zone.

Example (Sorting DateTime values chronologically)

import { Array, DateTime } from "effect"

const dates = [
  DateTime.makeUnsafe("2024-03-01"),
  DateTime.makeUnsafe("2024-01-01"),
  DateTime.makeUnsafe("2024-02-01")
]

const sorted = Array.sort(dates, DateTime.Order)
// Results in chronological order: 2024-01-01, 2024-02-01, 2024-03-01

Signature

declare const Order: order.Order<DateTime>

Source

Since v3.6.0