@burglekitt/gmt/dist/plain/calculate/sortDateTimes.js

Temporal-based date and time utilities with timezone support and polyfill integration

import { Temporal } from "@js-temporal/polyfill";
import { isValidDateTime } from "../validate/index.js";
/**
 * Sort an array of PlainDateTime values in ascending or descending order.
 *
 * - Returns empty array if no valid datetimes.
 * - Validation is performed on each item in the array.
 *
 * @param dateTimes Array of ISO PlainDateTime strings (e.g. "2024-03-10T12:00:00")
 * @param order "asc" for ascending (earliest first) | "desc" for descending (latest first)
 * @returns Sorted array of datetime strings
 *
 * @example sortDateTimes(["2024-03-10T12:00:00", "2024-01-01T08:00:00", "2024-02-15T15:30:00"]) // ["2024-01-01T08:00:00", "2024-02-15T15:30:00", "2024-03-10T12:00:00"]
 * @example sortDateTimes([]) // []
 */
export function sortDateTimes(dateTimes, order = "asc") {
    if (!dateTimes.length)
        return [];
    const valid = dateTimes.filter(isValidDateTime);
    if (!valid.length)
        return [];
    try {
        const comparables = valid.map((d) => Temporal.PlainDateTime.from(d));
        comparables.sort(Temporal.PlainDateTime.compare);
        if (order === "desc") {
            return comparables.reverse().map((d) => d.toString());
        }
        return comparables.map((d) => d.toString());
    }
    catch {
        return [];
    }
}