@burglekitt/gmt/dist/plain/interval/intervalFromDurationDate.d.ts

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

import type { Overflow } from "../../types/index.js";
/**
 * Construct a date interval from a single point plus an ISO 8601 duration, anchored at either end.
 *
 * - `anchor: "start"` treats `value` as the interval start and adds `duration` to get the end.
 * - `anchor: "end"` treats `value` as the interval end and subtracts `duration` to get the start.
 * - Uses `Temporal.PlainDate.prototype.add`/`.subtract`, so calendar units (years/months/weeks)
 *   resolve against `value` itself — no separate `relativeTo` is needed, unlike `addDuration`.
 * - A negative `duration` (e.g. `"-P1D"`) can invert the computed span; returns null when that
 *   happens, mirroring `intervalIntersectionDate`'s `start > end` rejection.
 * - `overflow` ("constrain" (default) | "reject") controls out-of-range results, e.g. adding 1 month
 *   to Jan 31: "constrain" clamps to Feb 29/28, "reject" returns null.
 * - Accepts a GMT calendar-annotated PlainDate string — E5 (issue #78). The computed endpoint
 *   is resolved in `value`'s own calendar (no `relativeTo`/pair-matching question, since there
 *   is only one calendar-tagged input) and both endpoints are re-formatted in that calendar,
 *   re-derived from the actual result rather than copied from `value`'s tag (a leap-month or
 *   era boundary can fall between them).
 * - Returns null on invalid input (unparseable `value`, invalid `duration`, or an `anchor` other
 *   than `"start"`/`"end"`).
 *
 * @param value ISO PlainDate string, optionally calendar-annotated
 * @param duration ISO 8601 duration string
 * @param anchor "start" | "end" — which endpoint `value` represents
 * @param options optional: overflow ("constrain" | "reject")
 * @returns `{ start, end }` with the constructed span, or null on invalid input
 *
 * @example intervalFromDurationDate("2024-01-01", "P1M", "start") // { start: "2024-01-01", end: "2024-02-01" }
 * @example intervalFromDurationDate("2024-02-01", "P1M", "end") // { start: "2024-01-01", end: "2024-02-01" }
 * @example intervalFromDurationDate("2024-01-31", "P1M", "start", { overflow: "reject" }) // null
 * @example intervalFromDurationDate("2024-01-05", "-P10D", "start") // null (inverted span)
 * @example intervalFromDurationDate("invalid", "P1M", "start") // null
 * @example intervalFromDurationDate("5784-06-15[u-ca=hebrew]", "P1M", "start") // { start: "5784-06-15[u-ca=hebrew]", end: "5784-07-15[u-ca=hebrew]" } (Adar I -> Adar)
 */
export declare function intervalFromDurationDate(value: string, duration: string, anchor: "start" | "end", options?: {
    overflow?: Overflow;
}): {
    start: string;
    end: string;
} | null;