@burglekitt/gmt/dist/plain/map/mapDatesInRange.js

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

import { Temporal } from "@js-temporal/polyfill";
import { isValidDate } from "../validate/index.js";
/**
 * Return an array of ISO PlainDate strings between `startDate` and `endDate` inclusive.
 *
 * - Generates dates with optional step (default 1 day).
 * - Returns [] if start > end, invalid inputs, or step <= 0.
 *
 * @param startDate ISO PlainDate string for the first date
 * @param endDate ISO PlainDate string for the last date (inclusive)
 * @param stepDays optional number of days to step between results
 * @returns array of ISO PlainDate strings, or [] on invalid input
 *
 * @example mapDatesInRange("2024-03-01", "2024-03-05") // ["2024-03-01", "2024-03-02", "2024-03-03", "2024-03-04", "2024-03-05"]
 * @example mapDatesInRange("2024-03-01", "2024-03-05", 2) // ["2024-03-01", "2024-03-03", "2024-03-05"]
 * @example mapDatesInRange("2024-03-05", "2024-03-01") // []
 * @example mapDatesInRange("invalid", "2024-03-05") // []
 * @example mapDatesInRange("2024-03-01", "invalid") // []
 * @example mapDatesInRange("2024-03-01", "2024-03-05", 0) // []
 */
export function mapDatesInRange(startDate, endDate, ...stepDaysInput) {
    const resolvedStepDays = stepDaysInput.length === 0 ? 1 : stepDaysInput[0];
    if (typeof resolvedStepDays !== "number" ||
        !Number.isInteger(resolvedStepDays) ||
        resolvedStepDays <= 0) {
        return [];
    }
    if (!isValidDate(startDate) || !isValidDate(endDate)) {
        return [];
    }
    try {
        const start = Temporal.PlainDate.from(startDate);
        const end = Temporal.PlainDate.from(endDate);
        if (Temporal.PlainDate.compare(start, end) === 1) {
            return [];
        }
        const result = [];
        for (let current = start; Temporal.PlainDate.compare(current, end) <= 0; current = current.add({ days: resolvedStepDays })) {
            result.push(current.toString());
        }
        return result;
    }
    catch {
        return [];
    }
}