{ "package": "@arki/date", "version": "0.3.0", "entries": [ { "subpath": ".", "name": "absDuration", "kind": "function", "signature": "export declare function absDuration(d: Duration): Duration;", "jsdocSummary": "The duration with every field made non-negative." }, { "subpath": ".", "name": "abuts", "kind": "function", "signature": "export declare function abuts(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Does one interval end exactly where the other starts (`a.end == b.start` or `b.end == a.start`)?" }, { "subpath": ".", "name": "add", "kind": "function", "signature": "export declare function add(value: T, amount: Amount | Duration, options?: ArithmeticOptions): T; ; export declare function add(value: T, amount: AmountFor> | Duration, options?: ArithmeticOptions): T;", "jsdocSummary": "`value + amount`. Calendar amounts are rejected on an `Instant` (project it into a zone first)." }, { "subpath": ".", "name": "addBusinessDays", "kind": "function", "signature": "export declare function addBusinessDays(value: T, count: number, calendar?: BusinessCalendar): T;", "jsdocSummary": "Move `count` business days forward (negative: backward). The start day is not counted, so Friday + 1 is Monday; `count` 0 returns `value` unchanged. Zoned values keep their wall-clock time. `count` must be a safe integer." }, { "subpath": ".", "name": "addDuration", "kind": "function", "signature": "export declare function addDuration(a: Duration, b: Duration): Duration;", "jsdocSummary": "`a + b` by field groups: (years, months) as months, (weeks, days) as days, (hours…ns) exactly. Groups never carry into each other; weeks survive only when neither input has days. Throws `RangeError` when groups end with mixed signs." }, { "subpath": ".", "name": "age", "kind": "function", "signature": "export declare function age(birthDate: PlainDate, asOf: PlainDate, options?: AgeOptions): number;", "jsdocSummary": "Completed years between a birth date and `asOf`. Throws if `asOf` is before the birth date." }, { "subpath": ".", "name": "AgeOptions", "kind": "type", "signature": "export type AgeOptions = Readonly<{ /** When a Feb 29 birthday is celebrated in common years. Default `feb28`. */ leapDay?: 'feb28' | 'mar1'; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "Amount", "kind": "type", "signature": "export type Amount = CalendarAmount & TimeAmount;", "jsdocSummary": "" }, { "subpath": ".", "name": "AmountFor", "kind": "type", "signature": "export type AmountFor = Instant extends T ? TimeAmount : Amount;", "jsdocSummary": "The amounts a point type accepts: anything for civil values (a `PlainDate` balances time fields into whole days, as Temporal does), time only for an `Instant` or a union containing one." }, { "subpath": ".", "name": "ArithmeticOptions", "kind": "type", "signature": "export type ArithmeticOptions = Readonly<{ overflow?: Overflow; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "atTime", "kind": "function", "signature": "export declare function atTime(date: PlainDate, time: Partial, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "A calendar date at a wall-clock time in a zone." }, { "subpath": ".", "name": "Bounds", "kind": "type", "signature": "export type Bounds = '[)' | '[]' | '()' | '(]';", "jsdocSummary": "Interval bounds notation: `[` / `]` inclusive, `(` / `)` exclusive." }, { "subpath": ".", "name": "BucketUnitFor", "kind": "type", "signature": "export type BucketUnitFor = PlainDate extends T ? CalendarUnit : Unit;", "jsdocSummary": "Units a value can be bucketed by: instants may use calendar units once projected into `timeZone`." }, { "subpath": ".", "name": "businessCalendar", "kind": "function", "signature": "export declare function businessCalendar(options?: BusinessCalendarOptions): BusinessCalendar;", "jsdocSummary": "A validated business calendar. Weekend days are deduplicated and sorted; a weekend of all seven days is a `RangeError` (no day could ever be a business day). Holiday strings must be `YYYY-MM-DD` (validated with `plainDate()`)." }, { "subpath": ".", "name": "BusinessCalendar", "kind": "type", "signature": "export type BusinessCalendar = Readonly<{ weekend: readonly Weekday[]; holidays: ReadonlySet; }>;", "jsdocSummary": "Which weekdays are off and which dates are holidays. `holidays` holds ISO `YYYY-MM-DD` strings. The record and its `weekend` list are frozen; build a new calendar with `businessCalendar()` rather than changing one." }, { "subpath": ".", "name": "BusinessCalendarOptions", "kind": "type", "signature": "export type BusinessCalendarOptions = Readonly<{ /** ISO weekdays that are off (Monday = 1 … Sunday = 7). Default `[6, 7]`. */ weekend?: readonly Weekday[]; /** Days off, as `PlainDate`s or `YYYY-MM-DD` strings. */ holidays?: Iterable; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "businessDaysBetween", "kind": "function", "signature": "export declare function businessDaysBetween(from: PlainDate, to: PlainDate, calendar?: BusinessCalendar): number;", "jsdocSummary": "Business days in `[from, to)`. Reversed arguments give the negated count: `businessDaysBetween(a, b) === -businessDaysBetween(b, a)`." }, { "subpath": ".", "name": "businessDaysIn", "kind": "function", "signature": "export declare function businessDaysIn(i: Interval, calendar?: BusinessCalendar): number;", "jsdocSummary": "Business days inside a `PlainDate` interval (its end is exclusive)." }, { "subpath": ".", "name": "CalendarAmount", "kind": "type", "signature": "export type CalendarAmount = Readonly<{ years?: number; quarters?: number; months?: number; weeks?: number; days?: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "calendarDaysBetween", "kind": "function", "signature": "export declare function calendarDaysBetween(from: PlainDate, to: PlainDate): number;", "jsdocSummary": "Whole calendar days from `from` to `to` (negative when reversed). Counts date boundaries, not elapsed hours." }, { "subpath": ".", "name": "CalendarUnit", "kind": "type", "signature": "export type CalendarUnit = 'year' | 'quarter' | 'month' | 'week' | 'day';", "jsdocSummary": "" }, { "subpath": ".", "name": "CalendarUntilOptions", "kind": "type", "signature": "export type CalendarUntilOptions = Readonly<{ largestUnit: Exclude; smallestUnit?: Exclude; roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "ceil", "kind": "function", "signature": "export declare function ceil(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function ceil(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round up to the unit; a value already on the boundary is returned unchanged." }, { "subpath": ".", "name": "Civil", "kind": "type", "signature": "export type Civil = PlainDate | PlainDateTime | ZonedDateTime;", "jsdocSummary": "Points that carry calendar fields (year, month, day)." }, { "subpath": ".", "name": "clamp", "kind": "function", "signature": "export declare function clamp(value: T, minimum: NoInfer, maximum: NoInfer): T;", "jsdocSummary": "`value` limited to `[minimum, maximum]`." }, { "subpath": ".", "name": "ClockOptions", "kind": "type", "signature": "export type ClockOptions = Readonly<{ clock?: Clock; }>;", "jsdocSummary": "Which clock to read. Default: the system clock." }, { "subpath": ".", "name": "compareAsc", "kind": "function", "signature": "export declare function compareAsc(a: T, b: NoInfer): Ordering;", "jsdocSummary": "`-1` when `a` is earlier, `1` when later, `0` when equal. Usable directly as an `Array#sort` comparator." }, { "subpath": ".", "name": "compareDesc", "kind": "function", "signature": "export declare function compareDesc(a: T, b: NoInfer): Ordering;", "jsdocSummary": "" }, { "subpath": ".", "name": "compareDurations", "kind": "function", "signature": "export declare function compareDurations(a: Duration, b: Duration, options?: RelativeToOptions): Ordering;", "jsdocSummary": "`-1`, `0` or `1` by length. Calendar units need `relativeTo` (`P1M` vs `P30D` depends on the month)." }, { "subpath": ".", "name": "contains", "kind": "function", "signature": "export declare function contains(i: Interval, value: NoInfer | Interval>): boolean;", "jsdocSummary": "For a point: `start ≤ value < end`. For an interval: `b` lies entirely inside `i` (`i.start ≤ b.start` and `b.end ≤ i.end`); an empty `b` inside `i` counts." }, { "subpath": ".", "name": "createDateContext", "kind": "function", "signature": "export declare function createDateContext(options?: DateContextOptions): DateContext;", "jsdocSummary": "" }, { "subpath": ".", "name": "CurrentOptions", "kind": "type", "signature": "export type CurrentOptions = ClockOptions & Readonly<{ timeZone?: string; week?: WeekRules; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "date", "kind": "function", "signature": "export declare function date(input: DateLike, options?: DateContextOptions): DateValue;", "jsdocSummary": "Wrap a moment for fluent use. A `Date`, `Instant` or offset string is projected into `options.timeZone` (runtime zone by default); a `ZonedDateTime` or `[Zone]`-annotated string keeps its own zone." }, { "subpath": ".", "name": "DateBasis", "kind": "type", "signature": "export type DateBasis = { readonly basis: 'local'; } | { readonly basis: 'utc'; } | { readonly basis: 'zone'; readonly timeZone: string; };", "jsdocSummary": "Which clock a `Date`'s calendar fields were chosen in. Browser pickers that build `new Date(y, m, d)` use `local`; APIs that build `Date.UTC(...)` use `utc`." }, { "subpath": ".", "name": "DateContext", "kind": "type", "signature": "export type DateContext = Readonly<{ timeZone: string; locale: string; week: WeekRules; clock: Clock; /** The current moment in the context zone. */ now(): DateValue; /** Today's calendar date in the context zone. */ today(): PlainDate; date(input: DateLike): DateValue; isToday(value: Point): boolean; isPast(value: Instant | ZonedDateTime | Date): boolean; isFuture(value: Instant | ZonedDateTime | Date): boolean; }>;", "jsdocSummary": "A `date()` factory with zone, locale, week rules and clock bound once (inject a `MockClock` in tests)." }, { "subpath": ".", "name": "DateContextOptions", "kind": "type", "signature": "export type DateContextOptions = Readonly<{ timeZone?: string; locale?: string; week?: WeekRules; clock?: Clock; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "DateLike", "kind": "type", "signature": "export type DateLike = DateValue | ZonedDateTime | Instant | Date | string;", "jsdocSummary": "Anything a `DateValue` method accepts as \"the other moment\"." }, { "subpath": ".", "name": "DateParts", "kind": "type", "signature": "export type DateParts = Readonly<{ year: number; month: number; day: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "DateValue", "kind": "class", "signature": "export declare class DateValue { #private; constructor(value: ZonedDateTime, settings: Settings); /** The underlying immutable `ZonedDateTime`. */ value(): ZonedDateTime; toInstant(): Instant; toPlainDate(): PlainDate; toPlainDateTime(): PlainDateTime; /** A fresh mutable `Date` at this instant. */ toDate(): Date; toISO(): string; toString(): string; toJSON(): string; /** Numeric coercion is a bug waiting to happen; use `toInstant().epochMilliseconds`. */ [Symbol.toPrimitive](hint: string): string; get timeZoneId(): string; get locale(): string; get year(): number; get month(): number; get day(): number; get hour(): number; get minute(): number; get second(): number; get epochMilliseconds(): number; parts(): WallParts; add(amount: Amount | Duration, options?: ArithmeticOptions): DateValue; sub(amount: Amount | Duration, options?: ArithmeticOptions): DateValue; set(patch: Partial>, options?: SetOptions): DateValue; startOf(unit: Unit): DateValue; endOf(unit: Unit): DateValue; nextBoundary(unit: Unit): DateValue; floor(unit: Unit, options?: RoundOptions): DateValue; ceil(unit: Unit, options?: RoundOptions): DateValue; round(unit: Unit, options?: RoundOptions): DateValue; /** `other − this` in whole units (see `diff`). */ diff(other: DateLike, unit: Unit, options?: DiffOptions): number; until(other: DateLike, options: UntilOptions): Duration; /** Exact elapsed time to `other` (a day is 24 h here). */ diffElapsed(other: DateLike, unit: TimeUnit | 'day' | 'week', options?: DiffOptions): number; equals(other: DateLike): boolean; sameInstant(other: DateLike): boolean; compare(other: DateLike): -1 | 0 | 1; isBefore(other: DateLike): boolean; isAfter(other: DateLike): boolean; isSameOrBefore(other: DateLike): boolean; isSameOrAfter(other: DateLike): boolean; isSame(other: DateLike, unit: Unit, options?: SameOptions): boolean; isSameDay(other: DateLike): boolean; isSameWeek(other: DateLike): boolean; isSameMonth(other: DateLike): boolean; isSameYear(other: DateLike): boolean; isBetween(start: DateLike, end: DateLike, options?: Readonly<{ bounds?: Bounds; }>): boolean; clamp(minimum: DateLike, maximum: DateLike): DateValue; isToday(): boolean; isTomorrow(): boolean; isYesterday(): boolean; isThisWeek(): boolean; isThisMonth(): boolean; isThisYear(): boolean; isPast(): boolean; isFuture(): boolean; /** \"3 days ago\" / \"in 2 hours\" relative to the context clock. */ fromNow(options?: RelativeOptions): string; dayOfWeek(): Weekday; dayOfYear(): number; daysInMonth(): number; isLeapYear(): boolean; isWeekend(weekend?: readonly Weekday[]): boolean; isWeekday(weekend?: readonly Weekday[]): boolean; isoWeek(): WeekInfo; weekOf(rules?: WeekRules): WeekInfo; quarter(): 1 | 2 | 3 | 4; /** Same instant, another zone. */ inZone(timeZone: string): DateValue; /** Same wall clock, another zone (the instant changes). */ reinterpretZone(timeZone: string, options?: ZonedOptions): DateValue; toUTC(): DateValue; offset(): string; isBusinessDay(calendar?: BusinessCalendar): boolean; addBusinessDays(count: number, calendar?: BusinessCalendar): DateValue; subBusinessDays(count: number, calendar?: BusinessCalendar): DateValue; nextBusinessDay(calendar?: BusinessCalendar): DateValue; previousBusinessDay(calendar?: BusinessCalendar): DateValue; /** Token formatting (`'yyyy-MM-dd HH:mm'`) in the context locale. */ format(pattern: string, options?: FormatOptions): string; /** `Intl.DateTimeFormat` formatting in the context locale. */ formatIntl(options?: FormatIntlOptions): string; /** \"3 days ago\" / \"in 2 hours\" relative to `reference`. */ relativeTo(reference: DateLike, options?: RelativeOptions): string; /** Apply any function to the underlying value; a `ZonedDateTime` result is re-wrapped. */ pipe(fn: (value: ZonedDateTime) => R): R extends ZonedDateTime ? DateValue : R; }", "jsdocSummary": "An immutable moment in a zone with chainable operations. Create one with `date()`." }, { "subpath": ".", "name": "dayOfWeek", "kind": "function", "signature": "export declare function dayOfWeek(value: Civil): Weekday;", "jsdocSummary": "ISO weekday, Monday = 1 … Sunday = 7." }, { "subpath": ".", "name": "dayOfYear", "kind": "function", "signature": "export declare function dayOfYear(value: Civil): number;", "jsdocSummary": "" }, { "subpath": ".", "name": "days", "kind": "function", "signature": "export declare function days(n: number): Duration;", "jsdocSummary": "`n` calendar days. `n` must be an integer." }, { "subpath": ".", "name": "daysInMonth", "kind": "function", "signature": "export declare function daysInMonth(value: Civil): number;", "jsdocSummary": "" }, { "subpath": ".", "name": "daysInYear", "kind": "function", "signature": "export declare function daysInYear(value: Civil): number;", "jsdocSummary": "" }, { "subpath": ".", "name": "DEFAULT_BUSINESS_CALENDAR", "kind": "variable", "signature": "export declare const DEFAULT_BUSINESS_CALENDAR: BusinessCalendar;", "jsdocSummary": "Saturday and Sunday off, no holidays." }, { "subpath": ".", "name": "DEFAULT_WEEKEND", "kind": "variable", "signature": "export declare const DEFAULT_WEEKEND: readonly Weekday[];", "jsdocSummary": "" }, { "subpath": ".", "name": "diff", "kind": "function", "signature": "export declare function diff(from: T, to: NoInfer, unit: CalendarUnit, options?: DiffOptions): number; ; export declare function diff(from: T, to: NoInfer, unit: UnitFor>, options?: DiffOptions): number;", "jsdocSummary": "`to − from` as a number of units. Positive when `to` is later." }, { "subpath": ".", "name": "diffElapsed", "kind": "function", "signature": "export declare function diffElapsed(from: Timeline | Date, to: Timeline | Date, unit: TimeUnit | 'day' | 'week', options?: DiffOptions): number;", "jsdocSummary": "Elapsed time between two instants. Here a `day` is exactly 24 hours and a `week` 168 hours — use `diff` on zoned values for calendar days." }, { "subpath": ".", "name": "DiffOptions", "kind": "type", "signature": "export type DiffOptions = Readonly<{ /** Return the exact fractional total instead of truncating toward zero. */ fractional?: boolean; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "Disambiguation", "kind": "type", "signature": "export type Disambiguation = 'compatible' | 'earlier' | 'later' | 'reject';", "jsdocSummary": "What to do when a wall-clock time is skipped or repeated by a DST transition." }, { "subpath": ".", "name": "duration", "kind": "function", "signature": "export declare function duration(input: string | Amount | Duration): Duration;", "jsdocSummary": "A `Duration` from an ISO 8601 string (`P1DT2H`), an `Amount` (quarters become 3 months) or a `Duration` (returned as-is)." }, { "subpath": ".", "name": "Duration", "kind": "type", "signature": "export type Duration = Temporal.Duration;", "jsdocSummary": "A signed amount of time with separate calendar (years…days) and exact (hours…ns) fields." }, { "subpath": ".", "name": "DurationIntlOptions", "kind": "type", "signature": "export type DurationIntlOptions = Readonly<{ locale?: string; }> & Readonly;", "jsdocSummary": "" }, { "subpath": ".", "name": "DurationUnit", "kind": "type", "signature": "export type DurationUnit = Exclude;", "jsdocSummary": "Units a `Duration` can carry (Temporal has no quarter field; quarters expand to 3 months)." }, { "subpath": ".", "name": "each", "kind": "function", "signature": "export declare function each(i: Interval, step: AmountFor>, options?: IterateOptions): IterableIterator;", "jsdocSummary": "`start`, `start + step`, `start + 2 × step` … while before `end`. Each value is anchored at `start` (`add(start, step × n)`), never accumulated, so a monthly walk from Jan 31 gives Jan 31, Feb 28, Mar 31, Apr 30. The step needs a nonzero field and no negative ones (`RangeError` otherwise)." }, { "subpath": ".", "name": "easter", "kind": "function", "signature": "export declare function easter(year: number, rite?: EasterRite): PlainDate;", "jsdocSummary": "Easter Sunday of a year. `'western'` is the Gregorian computus (Meeus/ Jones/Butcher); `'orthodox'` is the Julian computus (Meeus) converted to the ISO calendar, so both results are dates you can compare and add to directly. Movable feasts are offsets: Good Friday is `-2` days, Pentecost `+49`." }, { "subpath": ".", "name": "EasterRite", "kind": "type", "signature": "export type EasterRite = 'western' | 'orthodox';", "jsdocSummary": "`'western'` (Gregorian computus) or `'orthodox'` (Julian computus, shown on the ISO calendar)." }, { "subpath": ".", "name": "elapsedNanoseconds", "kind": "function", "signature": "export declare function elapsedNanoseconds(from: Timeline | Date, to: Timeline | Date): bigint;", "jsdocSummary": "Exact nanoseconds from `from` to `to`, ignoring calendars and zones." }, { "subpath": ".", "name": "endOf", "kind": "function", "signature": "export declare function endOf(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function endOf(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The last representable moment of the unit: the next boundary minus one day for a `PlainDate`, minus one nanosecond otherwise. Prefer `[startOf, nextBoundary)` for range queries; `endOf` exists for display and inclusive APIs." }, { "subpath": ".", "name": "equals", "kind": "function", "signature": "export declare function equals(a: T, b: NoInfer): boolean;", "jsdocSummary": "Field-for-field equality (for zoned values: same instant *and* same zone)." }, { "subpath": ".", "name": "floor", "kind": "function", "signature": "export declare function floor(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function floor(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round down to the unit (or to a multiple of it via `increment`). Same as `startOf` for calendar units." }, { "subpath": ".", "name": "format", "kind": "function", "signature": "export declare function format(value: Point | Date, pattern: string, options?: FormatOptions): string;", "jsdocSummary": "Format with a Unicode LDML pattern, producing the same text as date-fns v4 `format` (en-US) for the supported tokens." }, { "subpath": ".", "name": "formatDurationIntl", "kind": "function", "signature": "export declare function formatDurationIntl(d: Duration, options?: DurationIntlOptions): string;", "jsdocSummary": "Locale-native duration text through `Intl.DurationFormat`: `formatDurationIntl(d, { style: 'short' })` → `1 hr, 30 min` (en-US), with proper plurals in every locale. Unlike `humanizeDuration` the text depends on the runtime's ICU data, and engines without `Intl.DurationFormat` (Hermes, Node ≤ 22) throw a `RangeError` — use `humanizeDuration` when every runtime must print the same text." }, { "subpath": ".", "name": "formatDurationISO", "kind": "function", "signature": "export declare function formatDurationISO(d: Duration): string;", "jsdocSummary": "ISO 8601 duration text, e.g. `P1DT2H`." }, { "subpath": ".", "name": "formatIntl", "kind": "function", "signature": "export declare function formatIntl(value: Point | Date, options?: FormatIntlOptions): string;", "jsdocSummary": "Locale-native output through `Intl.DateTimeFormat` (`dateStyle`, `month: 'long'`, …)." }, { "subpath": ".", "name": "FormatIntlOptions", "kind": "type", "signature": "export type FormatIntlOptions = Readonly & FormatOptions;", "jsdocSummary": "`Intl.DateTimeFormat` options plus this package's `locale` / `timeZone`." }, { "subpath": ".", "name": "formatISO", "kind": "function", "signature": "export declare function formatISO(value: Point | Duration): string;", "jsdocSummary": "ISO 8601 / RFC 9557 text: the value's `toString()` (`2026-05-20`, `PT1H30M`, `…+03:00[Europe/Bucharest]`)." }, { "subpath": ".", "name": "FormatOptions", "kind": "type", "signature": "export type FormatOptions = Readonly<{ locale?: string; timeZone?: string; }>;", "jsdocSummary": "Locale (BCP 47, default `'en-US'`) and time zone (IANA id) for formatting." }, { "subpath": ".", "name": "formatRange", "kind": "function", "signature": "export declare function formatRange(start: Point | Date, end: Point | Date, options?: FormatIntlOptions): string;", "jsdocSummary": "Locale text for a span, through `Intl.DateTimeFormat#formatRange`: `formatRange(plainDate('2026-05-20'), plainDate('2026-05-24'), { dateStyle: 'medium' })` → `May 20 – 24, 2026`. Both ends follow the same rules as `formatIntl` and must be the same kind of value; the end may precede the start. Engines without `formatRange` (Hermes V1) throw a `RangeError`." }, { "subpath": ".", "name": "fromDate", "kind": "function", "signature": "export declare function fromDate(value: Date): Instant;", "jsdocSummary": "The instant a `Date` represents." }, { "subpath": ".", "name": "fromMillis", "kind": "function", "signature": "export declare function fromMillis(milliseconds: number): Instant;", "jsdocSummary": "Unix time in whole milliseconds (the `Date.now()` convention)." }, { "subpath": ".", "name": "fromPickerDate", "kind": "function", "signature": "export declare function fromPickerDate(value: Date, basis?: DateBasis): PlainDate;", "jsdocSummary": "The calendar date a picker selected, read from the `Date`'s fields in the stated basis." }, { "subpath": ".", "name": "fromUnix", "kind": "function", "signature": "export declare function fromUnix(seconds: number): Instant;", "jsdocSummary": "Unix time in seconds (fractions allowed, kept to nanosecond precision)." }, { "subpath": ".", "name": "gap", "kind": "function", "signature": "export declare function gap(a: Interval, b: Interval>): Interval | null;", "jsdocSummary": "The interval strictly between two separated intervals, or `null` when they overlap or touch." }, { "subpath": ".", "name": "gapsBetween", "kind": "function", "signature": "export declare function gapsBetween(list: readonly Interval[]): readonly Interval[];", "jsdocSummary": "The holes between the merged intervals, in order (empty when they form one block)." }, { "subpath": ".", "name": "hours", "kind": "function", "signature": "export declare function hours(n: number): Duration;", "jsdocSummary": "`n` hours. `n` must be an integer." }, { "subpath": ".", "name": "humanizeDuration", "kind": "function", "signature": "export declare function humanizeDuration(d: Duration, options?: HumanizeOptions): string;", "jsdocSummary": "Locale text such as \"1 day and 2 hours\" (`Intl.NumberFormat` units joined by `Intl.ListFormat`). Zero-valued units are skipped; a negative duration is the absolute text prefixed with `-`; a zero duration prints 0 of the smallest unit." }, { "subpath": ".", "name": "HumanizeOptions", "kind": "type", "signature": "export type HumanizeOptions = Readonly<{ locale?: string; units?: readonly DurationUnit[]; style?: 'long' | 'short' | 'narrow'; /** Keep only the N largest nonzero units; the rest is dropped, not rounded. */ maximumUnits?: number; relativeTo?: PlainDate | ZonedDateTime; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "instant", "kind": "function", "signature": "export declare function instant(input: string | Date | Timeline): Instant;", "jsdocSummary": "An exact moment. Strings must carry `Z` or an offset; `Date` is copied by its epoch milliseconds." }, { "subpath": ".", "name": "Instant", "kind": "type", "signature": "export type Instant = Temporal.Instant;", "jsdocSummary": "An exact moment on the timeline, zone-less: timestamps, logs, `timestamptz`." }, { "subpath": ".", "name": "intersection", "kind": "function", "signature": "export declare function intersection(a: Interval, b: Interval>): Interval | null;", "jsdocSummary": "The points in both intervals, or `null` when they share none." }, { "subpath": ".", "name": "interval", "kind": "function", "signature": "export declare function interval(start: T, end: NoInfer, options?: IntervalOptions): Interval;", "jsdocSummary": "A half-open interval `[start, end)`. With `bounds`, the inputs are read in that notation and normalized: an inclusive end (`]`) or an exclusive start (`(`) moves forward by one day on a `PlainDate` and one nanosecond otherwise. `interval(d, d, { bounds: '[]' })` is the one-day interval `[d, d + 1 day)`. Throws `RangeError` when `start` is after `end` once normalized; mixed kinds throw `TypeError`." }, { "subpath": ".", "name": "Interval", "kind": "type", "signature": "export type Interval = Readonly<{ start: T; end: T; }>;", "jsdocSummary": "A half-open range `[start, end)`: `start` is included, `end` is **excluded**. `start` is never after `end`; `start == end` is the empty interval." }, { "subpath": ".", "name": "intervalEquals", "kind": "function", "signature": "export declare function intervalEquals(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Same start and same end (zoned values compare by instant, so the zones may differ)." }, { "subpath": ".", "name": "intervalLength", "kind": "function", "signature": "export declare function intervalLength(i: Interval, unit: UnitFor>, options?: DiffOptions): number;", "jsdocSummary": "The length of the interval in `unit`: `diff(start, end, unit, options)`. Whole units truncated toward zero unless `fractional: true`." }, { "subpath": ".", "name": "IntervalOptions", "kind": "type", "signature": "export type IntervalOptions = Readonly<{ /** Bound notation of the inputs: `[` / `]` inclusive, `(` / `)` exclusive. Default `[)`. */ bounds?: Bounds; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "inZone", "kind": "function", "signature": "export declare function inZone(value: Timeline | Date, timeZone: string): ZonedDateTime;", "jsdocSummary": "The same instant, shown in another zone." }, { "subpath": ".", "name": "isAfter", "kind": "function", "signature": "export declare function isAfter(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isBefore", "kind": "function", "signature": "export declare function isBefore(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isBetween", "kind": "function", "signature": "export declare function isBetween(value: T, start: NoInfer, end: NoInfer, options?: Readonly<{ bounds?: Bounds; }>): boolean;", "jsdocSummary": "Is `value` inside `[start, end)` (or the given `bounds`)? Reversed bounds throw." }, { "subpath": ".", "name": "isBusinessDay", "kind": "function", "signature": "export declare function isBusinessDay(value: Civil, calendar?: BusinessCalendar): boolean;", "jsdocSummary": "Is the value's date neither a weekend day nor a holiday?" }, { "subpath": ".", "name": "isDuration", "kind": "function", "signature": "export declare function isDuration(value: unknown): value is Duration;", "jsdocSummary": "" }, { "subpath": ".", "name": "isEmptyInterval", "kind": "function", "signature": "export declare function isEmptyInterval(i: Interval): boolean;", "jsdocSummary": "Does the interval cover nothing (`start == end`)?" }, { "subpath": ".", "name": "isFuture", "kind": "function", "signature": "export declare function isFuture(value: Timeline | Date, options?: ClockOptions): boolean;", "jsdocSummary": "Strictly after now." }, { "subpath": ".", "name": "isInstant", "kind": "function", "signature": "export declare function isInstant(value: unknown): value is Instant;", "jsdocSummary": "" }, { "subpath": ".", "name": "isLeapYear", "kind": "function", "signature": "export declare function isLeapYear(value: Civil | number): boolean;", "jsdocSummary": "Gregorian leap-year rule, for a value or a bare year number." }, { "subpath": ".", "name": "isNegativeDuration", "kind": "function", "signature": "export declare function isNegativeDuration(d: Duration): boolean;", "jsdocSummary": "True when the duration points backward (any field is negative)." }, { "subpath": ".", "name": "ISO_WEEK", "kind": "variable", "signature": "export declare const ISO_WEEK: WeekRules;", "jsdocSummary": "ISO 8601 weeks: Monday start, week 1 contains January 4. The package default." }, { "subpath": ".", "name": "isoWeek", "kind": "function", "signature": "export declare function isoWeek(value: Civil): WeekInfo;", "jsdocSummary": "ISO 8601 week and week-year." }, { "subpath": ".", "name": "isPast", "kind": "function", "signature": "export declare function isPast(value: Timeline | Date, options?: ClockOptions): boolean;", "jsdocSummary": "Strictly before now." }, { "subpath": ".", "name": "isPlainDate", "kind": "function", "signature": "export declare function isPlainDate(value: unknown): value is PlainDate;", "jsdocSummary": "" }, { "subpath": ".", "name": "isPlainDateTime", "kind": "function", "signature": "export declare function isPlainDateTime(value: unknown): value is PlainDateTime;", "jsdocSummary": "" }, { "subpath": ".", "name": "isPoint", "kind": "function", "signature": "export declare function isPoint(value: unknown): value is Point;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSame", "kind": "function", "signature": "export declare function isSame(a: T, b: NoInfer, unit: BucketUnitFor>, options?: SameOptions): boolean; ; export declare function isSame(a: Instant, b: Instant, unit: Unit, options: SameOptions & { timeZone: string; }): boolean; ; export declare function isSame(a: T, b: NoInfer, unit: BucketUnitFor>, options?: SameOptions): boolean;", "jsdocSummary": "Do both values fall in the same calendar unit (day, ISO week, month, quarter, year, hour…)?" }, { "subpath": ".", "name": "isSameDay", "kind": "function", "signature": "export declare function isSameDay(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameMonth", "kind": "function", "signature": "export declare function isSameMonth(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameOrAfter", "kind": "function", "signature": "export declare function isSameOrAfter(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameOrBefore", "kind": "function", "signature": "export declare function isSameOrBefore(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameQuarter", "kind": "function", "signature": "export declare function isSameQuarter(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameWeek", "kind": "function", "signature": "export declare function isSameWeek(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isSameYear", "kind": "function", "signature": "export declare function isSameYear(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isThisMonth", "kind": "function", "signature": "export declare function isThisMonth(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isThisWeek", "kind": "function", "signature": "export declare function isThisWeek(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isThisYear", "kind": "function", "signature": "export declare function isThisYear(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isToday", "kind": "function", "signature": "export declare function isToday(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isTomorrow", "kind": "function", "signature": "export declare function isTomorrow(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isValidTimeZone", "kind": "function", "signature": "export declare function isValidTimeZone(id: string): boolean;", "jsdocSummary": "Is this a time zone the runtime knows (IANA name or fixed offset)?" }, { "subpath": ".", "name": "isWeekday", "kind": "function", "signature": "export declare function isWeekday(value: Civil, weekend?: readonly Weekday[]): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isWeekend", "kind": "function", "signature": "export declare function isWeekend(value: Civil, weekend?: readonly Weekday[]): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isYesterday", "kind": "function", "signature": "export declare function isYesterday(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": ".", "name": "isZeroDuration", "kind": "function", "signature": "export declare function isZeroDuration(d: Duration): boolean;", "jsdocSummary": "True when every field is zero." }, { "subpath": ".", "name": "isZonedDateTime", "kind": "function", "signature": "export declare function isZonedDateTime(value: unknown): value is ZonedDateTime;", "jsdocSummary": "" }, { "subpath": ".", "name": "IterateOptions", "kind": "type", "signature": "export type IterateOptions = Readonly<{ /** Throw a `RangeError` rather than produce more than this many values. Default 10 000. */ maxItems?: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "kindOf", "kind": "function", "signature": "export declare function kindOf(value: Point): PointKind;", "jsdocSummary": "" }, { "subpath": ".", "name": "lastWeekdayOfMonth", "kind": "function", "signature": "export declare function lastWeekdayOfMonth(year: number, month: number, weekday: Weekday): PlainDate;", "jsdocSummary": "The last `weekday` of a month: `nthWeekdayOfMonth(year, month, -1, weekday)`." }, { "subpath": ".", "name": "max", "kind": "function", "signature": "export declare function max(values: readonly [T, ...T[]]): T;", "jsdocSummary": "The latest of the given values." }, { "subpath": ".", "name": "mergeIntervals", "kind": "function", "signature": "export declare function mergeIntervals(list: readonly Interval[]): readonly Interval[];", "jsdocSummary": "Sort and merge: overlapping and touching intervals join; empty intervals are dropped (they cover nothing). The result is sorted, disjoint and never touching." }, { "subpath": ".", "name": "milliseconds", "kind": "function", "signature": "export declare function milliseconds(n: number): Duration;", "jsdocSummary": "`n` milliseconds. `n` must be an integer." }, { "subpath": ".", "name": "min", "kind": "function", "signature": "export declare function min(values: readonly [T, ...T[]]): T;", "jsdocSummary": "The earliest of the given values (one of the inputs, not a copy)." }, { "subpath": ".", "name": "minutes", "kind": "function", "signature": "export declare function minutes(n: number): Duration;", "jsdocSummary": "`n` minutes. `n` must be an integer." }, { "subpath": ".", "name": "months", "kind": "function", "signature": "export declare function months(n: number): Duration;", "jsdocSummary": "`n` months. `n` must be an integer." }, { "subpath": ".", "name": "multiplyDuration", "kind": "function", "signature": "export declare function multiplyDuration(d: Duration, factor: number): Duration;", "jsdocSummary": "Every field times `factor` (a safe integer). Fields are scaled as-is, never re-balanced." }, { "subpath": ".", "name": "negateDuration", "kind": "function", "signature": "export declare function negateDuration(d: Duration): Duration;", "jsdocSummary": "The same duration pointing the other way." }, { "subpath": ".", "name": "nextBoundary", "kind": "function", "signature": "export declare function nextBoundary(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function nextBoundary(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The start of the unit after the one containing `value` — the exclusive end of `startOf(value, unit)`. Always after `value`." }, { "subpath": ".", "name": "nextBusinessDay", "kind": "function", "signature": "export declare function nextBusinessDay(value: T, calendar?: BusinessCalendar): T;", "jsdocSummary": "The first business day strictly after `value` (same wall-clock time for zoned values)." }, { "subpath": ".", "name": "normalizeDuration", "kind": "function", "signature": "export declare function normalizeDuration(d: Duration, options: NormalizeOptions): Duration;", "jsdocSummary": "Re-balance across units with Temporal's `Duration#round`. Calendar units (years, months, weeks) need `relativeTo`; without it a day counts as 24 hours." }, { "subpath": ".", "name": "NormalizeOptions", "kind": "type", "signature": "export type NormalizeOptions = Readonly<{ largestUnit: DurationUnit; smallestUnit?: DurationUnit; relativeTo?: PlainDate | ZonedDateTime; /** Temporal's default (`halfExpand`) when omitted. */ roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "now", "kind": "function", "signature": "export declare function now(options?: ClockOptions): Instant;", "jsdocSummary": "The current instant." }, { "subpath": ".", "name": "nowIn", "kind": "function", "signature": "export declare function nowIn(options?: CurrentOptions): ZonedDateTime;", "jsdocSummary": "The current moment in a zone (runtime zone by default)." }, { "subpath": ".", "name": "nthWeekdayOfMonth", "kind": "function", "signature": "export declare function nthWeekdayOfMonth(year: number, month: number, n: number, weekday: Weekday): PlainDate;", "jsdocSummary": "The n-th `weekday` of a month: `nthWeekdayOfMonth(2026, 5, 2, 5)` is the second Friday of May 2026. Negative `n` counts from the end (`-1` = last). A `RangeError` when the month has no such day (a fifth Monday, say)." }, { "subpath": ".", "name": "offset", "kind": "function", "signature": "export declare function offset(value: ZonedDateTime): string;", "jsdocSummary": "The UTC offset as text, e.g. `+03:00`." }, { "subpath": ".", "name": "offsetMinutes", "kind": "function", "signature": "export declare function offsetMinutes(value: ZonedDateTime): number;", "jsdocSummary": "The UTC offset in minutes (east positive)." }, { "subpath": ".", "name": "Ordering", "kind": "type", "signature": "export type Ordering = -1 | 0 | 1;", "jsdocSummary": "" }, { "subpath": ".", "name": "Overflow", "kind": "type", "signature": "export type Overflow = 'constrain' | 'reject';", "jsdocSummary": "What to do when a field is out of range: clamp (Jan 31 + 1 month = Feb 28) or throw." }, { "subpath": ".", "name": "overlaps", "kind": "function", "signature": "export declare function overlaps(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Do the intervals share at least one point? Touching intervals and empty intervals never overlap." }, { "subpath": ".", "name": "parseDate", "kind": "function", "signature": "export declare function parseDate(text: string, pattern: string, options?: ParseOptions): PlainDate;", "jsdocSummary": "A calendar date read from `text` laid out by `pattern`, e.g. `parseDate('Mar 5, 2026', 'MMM d, yyyy')`. The pattern needs a year and a month + day (or a day of year `D`). Time tokens are read, validated and dropped; offset tokens are refused (use `parseZoned`)." }, { "subpath": ".", "name": "parseDateTime", "kind": "function", "signature": "export declare function parseDateTime(text: string, pattern: string, options?: ParseOptions): PlainDateTime;", "jsdocSummary": "A wall-clock date and time read from `text` laid out by `pattern`, e.g. `parseDateTime('03/05/2026 9:30 PM', 'MM/dd/yyyy h:mm a')`. Missing time fields are zero; offset tokens are refused (use `parseZoned`)." }, { "subpath": ".", "name": "parseISO", "kind": "function", "signature": "export declare function parseISO(text: string, options?: ParseISOOptions): Instant;", "jsdocSummary": "Read lenient ISO 8601 text — everything `instant()` accepts plus the forms people actually send: `2026-05-20` (midnight), `2026-05`, `2026`, basic `20260520T1030`, week dates `2026-W41-5`, ordinal dates `2026-283`, a fraction on the last time unit, `24:00`, `±HH` offsets." }, { "subpath": ".", "name": "ParseISOOptions", "kind": "type", "signature": "export type ParseISOOptions = Readonly<{ /** Zone for text without an offset. Default: the runtime zone. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "ParseKinds", "kind": "type", "signature": "export type ParseKinds = { plainDate: PlainDate; plainDateTime: PlainDateTime; zoned: ZonedDateTime; instant: Instant; duration: Duration; /** Lenient ISO text via `parseISO`. */ iso: Instant; };", "jsdocSummary": "" }, { "subpath": ".", "name": "ParseOptions", "kind": "type", "signature": "export type ParseOptions = Readonly<{ locale?: string; }>;", "jsdocSummary": "Locale (BCP 47, default `'en-US'`) whose month, weekday and AM/PM words are accepted." }, { "subpath": ".", "name": "ParseResult", "kind": "type", "signature": "export type ParseResult = { readonly ok: true; readonly value: T; } | { readonly ok: false; readonly error: RangeError; };", "jsdocSummary": "" }, { "subpath": ".", "name": "parseZoned", "kind": "function", "signature": "export declare function parseZoned(text: string, pattern: string, timeZone: string, options?: ParseOptions & ZonedOptions): ZonedDateTime;", "jsdocSummary": "A moment in `timeZone` read from `text` laid out by `pattern`. With an offset token (`X`, `x`…) the text names an exact instant, which is shown in `timeZone`. Without one, the text is a wall-clock time in `timeZone`; skipped or repeated times resolve with `disambiguation` (default `'compatible'`)." }, { "subpath": ".", "name": "parts", "kind": "function", "signature": "export declare function parts(value: PlainDate): DateParts; ; export declare function parts(value: Wall): WallParts; ; export declare function parts(value: Civil): DateParts | WallParts;", "jsdocSummary": "The calendar (and, for wall-clock values, time) fields as a plain object." }, { "subpath": ".", "name": "PartsFor", "kind": "type", "signature": "export type PartsFor = T extends PlainDate ? DateParts : WallParts;", "jsdocSummary": "" }, { "subpath": ".", "name": "plainDate", "kind": "function", "signature": "export declare function plainDate(input: string | DateParts | Civil): PlainDate;", "jsdocSummary": "A calendar date. Accepts `YYYY-MM-DD` only — a timestamp string is rejected so that a zone and time are never silently dropped. Pass a `ZonedDateTime` when you really mean \"the date this moment falls on in its zone\"." }, { "subpath": ".", "name": "PlainDate", "kind": "type", "signature": "export type PlainDate = Temporal.PlainDate;", "jsdocSummary": "A calendar date with no time and no zone: a birthday, a due date, a holiday." }, { "subpath": ".", "name": "plainDateTime", "kind": "function", "signature": "export declare function plainDateTime(input: string | WallInput | Wall): PlainDateTime;", "jsdocSummary": "A wall-clock date and time with no zone. Strings carrying an offset or zone are rejected." }, { "subpath": ".", "name": "PlainDateTime", "kind": "type", "signature": "export type PlainDateTime = Temporal.PlainDateTime;", "jsdocSummary": "A wall-clock date + time with no zone: \"the meeting is at 09:00 local\"." }, { "subpath": ".", "name": "Point", "kind": "type", "signature": "export type Point = PlainDate | PlainDateTime | ZonedDateTime | Instant;", "jsdocSummary": "Any point-in-time value this package operates on." }, { "subpath": ".", "name": "PointKind", "kind": "type", "signature": "export type PointKind = 'plainDate' | 'plainDateTime' | 'zonedDateTime' | 'instant';", "jsdocSummary": "" }, { "subpath": ".", "name": "previousBusinessDay", "kind": "function", "signature": "export declare function previousBusinessDay(value: T, calendar?: BusinessCalendar): T;", "jsdocSummary": "The last business day strictly before `value` (same wall-clock time for zoned values)." }, { "subpath": ".", "name": "quarter", "kind": "function", "signature": "export declare function quarter(value: Civil): 1 | 2 | 3 | 4;", "jsdocSummary": "" }, { "subpath": ".", "name": "range", "kind": "function", "signature": "export declare function range(start: T, end: NoInfer, step: AmountFor>, options?: IterateOptions): IterableIterator;", "jsdocSummary": "`each(interval(start, end), step, options)`: values in `[start, end)` anchored at `start`." }, { "subpath": ".", "name": "reinterpretZone", "kind": "function", "signature": "export declare function reinterpretZone(value: ZonedDateTime, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "The same wall-clock fields, read as if they were in another zone (the instant changes)." }, { "subpath": ".", "name": "relative", "kind": "function", "signature": "export declare function relative(target: Timeline | Date, reference: Timeline | Date, options?: RelativeOptions): string;", "jsdocSummary": "Locale text for `target` seen from `reference`: \"in 3 days\", \"3 days ago\", or \"tomorrow\" with `numeric: 'auto'`." }, { "subpath": ".", "name": "RelativeOptions", "kind": "type", "signature": "export type RelativeOptions = Readonly<{ locale?: string; /** Force one unit, or `'auto'` (default) to pick by distance. */ unit?: RelativeUnit | 'auto'; /** `'auto'` allows words like \"yesterday\" and \"tomorrow\". Default `'always'`. */ numeric?: 'always' | 'auto'; style?: 'long' | 'short' | 'narrow'; /** Zone for calendar-day comparison. Default: the target's zone if zoned, else the runtime zone. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "relativeToNow", "kind": "function", "signature": "export declare function relativeToNow(target: Timeline | Date, options?: RelativeOptions & ClockOptions): string;", "jsdocSummary": "`relative(target, now({ clock }))`. Pass a `MockClock` for deterministic output." }, { "subpath": ".", "name": "RelativeToOptions", "kind": "type", "signature": "export type RelativeToOptions = Readonly<{ relativeTo?: PlainDate | ZonedDateTime; }>;", "jsdocSummary": "The anchor Temporal needs to measure calendar units (months have 28–31 days, days 23–25 hours)." }, { "subpath": ".", "name": "relativeUnit", "kind": "function", "signature": "export declare function relativeUnit(target: Timeline | Date, reference: Timeline | Date, options?: RelativeOptions): RelativeValue;", "jsdocSummary": "The unit and signed whole value `relative` would print. Auto selection: < 60 s → second, < 60 min → minute, < 24 h → hour (exact time), then by calendar days in the zone: < 7 days → day, < 1 month → week, < 12 months → month, else year." }, { "subpath": ".", "name": "RelativeUnit", "kind": "type", "signature": "export type RelativeUnit = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';", "jsdocSummary": "" }, { "subpath": ".", "name": "RelativeValue", "kind": "type", "signature": "export type RelativeValue = Readonly<{ unit: RelativeUnit; value: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "round", "kind": "function", "signature": "export declare function round(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function round(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round to the nearest unit boundary; ties go to the later boundary unless `tie: 'earlier'`." }, { "subpath": ".", "name": "RoundingMode", "kind": "type", "signature": "export type RoundingMode = 'trunc' | 'floor' | 'ceil' | 'halfExpand';", "jsdocSummary": "" }, { "subpath": ".", "name": "RoundOptions", "kind": "type", "signature": "export type RoundOptions = Readonly<{ /** Round to a multiple of the unit (e.g. 15 minutes). Calendar units support only 1. */ increment?: number; week?: WeekRules; /** For `round`: which side wins an exact tie. Default `later`. */ tie?: 'earlier' | 'later'; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "sameInstant", "kind": "function", "signature": "export declare function sameInstant(a: Timeline | Date, b: Timeline | Date): boolean;", "jsdocSummary": "Do two timeline values point at the same instant, whatever their zones?" }, { "subpath": ".", "name": "SameOptions", "kind": "type", "signature": "export type SameOptions = Readonly<{ week?: WeekRules; /** Zone in which to bucket. Required for instants; required for zoned values in different zones. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "seconds", "kind": "function", "signature": "export declare function seconds(n: number): Duration;", "jsdocSummary": "`n` seconds. `n` must be an integer." }, { "subpath": ".", "name": "set", "kind": "function", "signature": "export declare function set(value: T, patch: Partial>>, options?: SetOptions): T;", "jsdocSummary": "A copy with the given fields replaced. Out-of-range fields clamp unless `overflow: 'reject'`." }, { "subpath": ".", "name": "SetOptions", "kind": "type", "signature": "export type SetOptions = Readonly<{ overflow?: Overflow; disambiguation?: Disambiguation; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "splitByUnit", "kind": "function", "signature": "export declare function splitByUnit(i: Interval, unit: UnitFor>, options?: SplitOptions): IterableIterator>;", "jsdocSummary": "The interval cut at every `unit` boundary (`startOf` / `nextBoundary`; weeks per `options.week`, ISO by default). The first and last pieces may be partial; together the pieces rebuild the input exactly. An empty interval yields nothing." }, { "subpath": ".", "name": "SplitOptions", "kind": "type", "signature": "export type SplitOptions = Readonly<{ week?: WeekRules; maxItems?: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "startOf", "kind": "function", "signature": "export declare function startOf(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function startOf(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The first moment of the unit containing `value` (week per `options.week`, ISO by default)." }, { "subpath": ".", "name": "sub", "kind": "function", "signature": "export declare function sub(value: T, amount: Amount | Duration, options?: ArithmeticOptions): T; ; export declare function sub(value: T, amount: AmountFor> | Duration, options?: ArithmeticOptions): T;", "jsdocSummary": "`value − amount`. Not always the inverse of `add` (Jan 31 + 1 month − 1 month = Feb 28 − 1 month = Jan 28)." }, { "subpath": ".", "name": "subBusinessDays", "kind": "function", "signature": "export declare function subBusinessDays(value: T, count: number, calendar?: BusinessCalendar): T;", "jsdocSummary": "Move `count` business days backward: `addBusinessDays(value, -count)`." }, { "subpath": ".", "name": "subDuration", "kind": "function", "signature": "export declare function subDuration(a: Duration, b: Duration): Duration;", "jsdocSummary": "`a − b` with the same group policy as `addDuration` (`P1Y − P2M` = `P10M`; `P1D − PT1H` throws)." }, { "subpath": ".", "name": "subtract", "kind": "function", "signature": "export declare function subtract(a: Interval, b: Interval>): readonly Interval[];", "jsdocSummary": "The parts of `a` not covered by `b`: zero, one or two pieces, in order." }, { "subpath": ".", "name": "SUNDAY_WEEK", "kind": "variable", "signature": "export declare const SUNDAY_WEEK: WeekRules;", "jsdocSummary": "North-American convention: Sunday start, week 1 contains January 1." }, { "subpath": ".", "name": "symmetricDifference", "kind": "function", "signature": "export declare function symmetricDifference(a: Interval, b: Interval>): readonly Interval[];", "jsdocSummary": "The points in exactly one of the two intervals, as sorted disjoint pieces." }, { "subpath": ".", "name": "systemTimeZone", "kind": "function", "signature": "export declare function systemTimeZone(): string;", "jsdocSummary": "The runtime's IANA time zone (e.g. `Europe/Bucharest`). The lookup costs ~0.2 ms on the polyfill, so the answer is reused for one second; the zone can change at runtime (`process.env.TZ`, a travelling laptop) and a change shows up within that second." }, { "subpath": ".", "name": "Temporal", "kind": "namespace", "signature": "export namespace Temporal { type CalendarLike = | PlainDate | PlainDateTime | PlainMonthDay | PlainYearMonth | ZonedDateTime | string type DurationLike = Duration | DurationLikeObject | string type InstantLike = Instant | ZonedDateTime | string type PlainDateLike = | PlainDate | ZonedDateTime | PlainDateTime | DateLikeObject | string type PlainDateTimeLike = | PlainDateTime | ZonedDateTime | PlainDate | DateTimeLikeObject | string type PlainMonthDayLike = PlainMonthDay | DateLikeObject | string type PlainTimeLike = | PlainTime | PlainDateTime | ZonedDateTime | TimeLikeObject | string type PlainYearMonthLike = PlainYearMonth | YearMonthLikeObject | string type TimeZoneLike = ZonedDateTime | string type ZonedDateTimeLike = ZonedDateTime | ZonedDateTimeLikeObject | string type PartialTemporalLike = { [P in Exclude]?: T[P] | undefined } interface DateLikeObject { year?: number | undefined era?: string | undefined eraYear?: number | undefined month?: number | undefined monthCode?: string | undefined day: number calendar?: string | undefined } interface DateTimeLikeObject extends DateLikeObject, TimeLikeObject {} interface DurationLikeObject { years?: number | undefined months?: number | undefined weeks?: number | undefined days?: number | undefined hours?: number | undefined minutes?: number | undefined seconds?: number | undefined milliseconds?: number | undefined microseconds?: number | undefined nanoseconds?: number | undefined } interface TimeLikeObject { hour?: number | undefined minute?: number | undefined second?: number | undefined millisecond?: number | undefined microsecond?: number | undefined nanosecond?: number | undefined } interface YearMonthLikeObject extends Omit {} interface ZonedDateTimeLikeObject extends DateTimeLikeObject { timeZone: TimeZoneLike offset?: string | undefined } type DateUnit = 'year' | 'month' | 'week' | 'day' type TimeUnit = | 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond' | 'nanosecond' type PluralizeUnit = | T | { year: 'years' month: 'months' week: 'weeks' day: 'days' hour: 'hours' minute: 'minutes' second: 'seconds' millisecond: 'milliseconds' microsecond: 'microseconds' nanosecond: 'nanoseconds' }[T] interface DisambiguationOptions { disambiguation?: 'compatible' | 'earlier' | 'later' | 'reject' | undefined } interface OverflowOptions { overflow?: 'constrain' | 'reject' | undefined } interface TransitionOptions { direction: 'next' | 'previous' } interface RoundingOptions { smallestUnit?: PluralizeUnit | undefined roundingIncrement?: number | undefined roundingMode?: | 'ceil' | 'floor' | 'expand' | 'trunc' | 'halfCeil' | 'halfFloor' | 'halfExpand' | 'halfTrunc' | 'halfEven' | undefined } interface RoundingOptionsWithLargestUnit extends RoundingOptions { largestUnit?: 'auto' | PluralizeUnit | undefined } interface ToStringRoundingOptions extends Pick, 'smallestUnit' | 'roundingMode'> {} interface ToStringRoundingOptionsWithFractionalSeconds< Units extends DateUnit | TimeUnit, > extends ToStringRoundingOptions { fractionalSecondDigits?: | 'auto' | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined } namespace Now { function timeZoneId(): string function instant(): Instant function plainDateTimeISO(timeZone?: TimeZoneLike): PlainDateTime function zonedDateTimeISO(timeZone?: TimeZoneLike): ZonedDateTime function plainDateISO(timeZone?: TimeZoneLike): PlainDate function plainTimeISO(timeZone?: TimeZoneLike): PlainTime } interface PlainDateToStringOptions { calendarName?: 'auto' | 'always' | 'never' | 'critical' | undefined } interface PlainDateToZonedDateTimeOptions { plainTime?: PlainTimeLike | undefined timeZone: TimeZoneLike } interface PlainDate { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean toPlainYearMonth(): PlainYearMonth toPlainMonthDay(): PlainMonthDay add(duration: DurationLike, options?: OverflowOptions): PlainDate subtract(duration: DurationLike, options?: OverflowOptions): PlainDate with( dateLike: PartialTemporalLike, options?: OverflowOptions, ): PlainDate withCalendar(calendarLike: CalendarLike): PlainDate until( other: PlainDateLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainDateLike, options?: RoundingOptionsWithLargestUnit, ): Duration equals(other: PlainDateLike): boolean toPlainDateTime(time?: PlainTimeLike): PlainDateTime toZonedDateTime(timeZone: TimeZoneLike): ZonedDateTime toZonedDateTime(item: PlainDateToZonedDateTimeOptions): ZonedDateTime toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.PlainDate' } interface PlainDateConstructor { new ( isoYear: number, isoMonth: number, isoDay: number, calendar?: string, ): PlainDate readonly prototype: PlainDate from(item: PlainDateLike, options?: OverflowOptions): PlainDate compare(one: PlainDateLike, two: PlainDateLike): number } var PlainDate: PlainDateConstructor interface PlainTimeToStringOptions extends ToStringRoundingOptionsWithFractionalSeconds< Exclude > {} interface PlainTime { readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number add(duration: DurationLike): PlainTime subtract(duration: DurationLike): PlainTime with( timeLike: PartialTemporalLike, options?: OverflowOptions, ): PlainTime until( other: PlainTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration equals(other: PlainTimeLike): boolean round(roundTo: PluralizeUnit): PlainTime round(roundTo: RoundingOptions): PlainTime toString(options?: PlainTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.PlainTime' } interface PlainTimeConstructor { new ( hour?: number, minute?: number, second?: number, millisecond?: number, microsecond?: number, nanosecond?: number, ): PlainTime readonly prototype: PlainTime from(item: PlainTimeLike, options?: OverflowOptions): PlainTime compare(one: PlainTimeLike, two: PlainTimeLike): number } var PlainTime: PlainTimeConstructor interface PlainDateTimeToStringOptions extends PlainDateToStringOptions, PlainTimeToStringOptions {} interface PlainDateTime { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean with( dateTimeLike: PartialTemporalLike, options?: OverflowOptions, ): PlainDateTime withPlainTime(plainTime?: PlainTimeLike): PlainDateTime withCalendar(calendar: CalendarLike): PlainDateTime add(duration: DurationLike, options?: OverflowOptions): PlainDateTime subtract(duration: DurationLike, options?: OverflowOptions): PlainDateTime until( other: PlainDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): PlainDateTime round(roundTo: RoundingOptions<'day' | TimeUnit>): PlainDateTime equals(other: PlainDateTimeLike): boolean toString(options?: PlainDateTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toZonedDateTime( timeZone: TimeZoneLike, options?: DisambiguationOptions, ): ZonedDateTime toPlainDate(): PlainDate toPlainTime(): PlainTime readonly [Symbol.toStringTag]: 'Temporal.PlainDateTime' } interface PlainDateTimeConstructor { new ( isoYear: number, isoMonth: number, isoDay: number, hour?: number, minute?: number, second?: number, millisecond?: number, microsecond?: number, nanosecond?: number, calendar?: string, ): PlainDateTime readonly prototype: PlainDateTime from(item: PlainDateTimeLike, options?: OverflowOptions): PlainDateTime compare(one: PlainDateTimeLike, two: PlainDateTimeLike): number } var PlainDateTime: PlainDateTimeConstructor interface ZonedDateTimeToStringOptions extends PlainDateTimeToStringOptions { offset?: 'auto' | 'never' | undefined timeZoneName?: 'auto' | 'never' | 'critical' | undefined } interface ZonedDateTimeFromOptions extends OverflowOptions, DisambiguationOptions { offset?: 'use' | 'ignore' | 'prefer' | 'reject' | undefined } interface ZonedDateTime { readonly calendarId: string readonly timeZoneId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number readonly epochMilliseconds: number readonly epochNanoseconds: bigint readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly hoursInDay: number readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean readonly offsetNanoseconds: number readonly offset: string with( zonedDateTimeLike: PartialTemporalLike, options?: ZonedDateTimeFromOptions, ): ZonedDateTime withPlainTime(plainTime?: PlainTimeLike): ZonedDateTime withTimeZone(timeZone: TimeZoneLike): ZonedDateTime withCalendar(calendar: CalendarLike): ZonedDateTime add(duration: DurationLike, options?: OverflowOptions): ZonedDateTime subtract(duration: DurationLike, options?: OverflowOptions): ZonedDateTime until( other: ZonedDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: ZonedDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): ZonedDateTime round(roundTo: RoundingOptions<'day' | TimeUnit>): ZonedDateTime equals(other: ZonedDateTimeLike): boolean toString(options?: ZonedDateTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never startOfDay(): ZonedDateTime getTimeZoneTransition(direction: 'next' | 'previous'): ZonedDateTime | null getTimeZoneTransition(direction: TransitionOptions): ZonedDateTime | null toInstant(): Instant toPlainDate(): PlainDate toPlainTime(): PlainTime toPlainDateTime(): PlainDateTime readonly [Symbol.toStringTag]: 'Temporal.ZonedDateTime' } interface ZonedDateTimeConstructor { new ( epochNanoseconds: bigint, timeZone: string, calendar?: string, ): ZonedDateTime readonly prototype: ZonedDateTime from( item: ZonedDateTimeLike, options?: ZonedDateTimeFromOptions, ): ZonedDateTime compare(one: ZonedDateTimeLike, two: ZonedDateTimeLike): number } var ZonedDateTime: ZonedDateTimeConstructor interface DurationRelativeToOptions { relativeTo?: ZonedDateTimeLike | PlainDateLike | undefined } interface DurationRoundingOptions extends DurationRelativeToOptions, RoundingOptionsWithLargestUnit {} interface DurationToStringOptions extends ToStringRoundingOptionsWithFractionalSeconds< Exclude > {} interface DurationTotalOptions extends DurationRelativeToOptions { unit: PluralizeUnit } // Use the host's Intl.DurationFormat options when the consumer includes a // lib that declares Intl.DurationFormat, without forcing this file to // reference es2025.intl for every consumer. type DurationFormatOptions = typeof Intl extends { DurationFormat: { new (locales?: unknown, options?: infer Options): unknown } } ? NonNullable : unknown interface Duration { readonly years: number readonly months: number readonly weeks: number readonly days: number readonly hours: number readonly minutes: number readonly seconds: number readonly milliseconds: number readonly microseconds: number readonly nanoseconds: number readonly sign: number readonly blank: boolean with(durationLike: PartialTemporalLike): Duration negated(): Duration abs(): Duration add(other: DurationLike): Duration subtract(other: DurationLike): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): Duration round(roundTo: DurationRoundingOptions): Duration total(totalOf: PluralizeUnit<'day' | TimeUnit>): number total(totalOf: DurationTotalOptions): number toString(options?: DurationToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: DurationFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.Duration' } interface DurationConstructor { new ( years?: number, months?: number, weeks?: number, days?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number, microseconds?: number, nanoseconds?: number, ): Duration readonly prototype: Duration from(item: DurationLike): Duration compare( one: DurationLike, two: DurationLike, options?: DurationRelativeToOptions, ): number } var Duration: DurationConstructor interface InstantToStringOptions extends PlainTimeToStringOptions { timeZone?: TimeZoneLike | undefined } interface Instant { readonly epochMilliseconds: number readonly epochNanoseconds: bigint add(duration: DurationLike): Instant subtract(duration: DurationLike): Instant until( other: InstantLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: InstantLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit): Instant round(roundTo: RoundingOptions): Instant equals(other: InstantLike): boolean toString(options?: InstantToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toZonedDateTimeISO(timeZone: TimeZoneLike): ZonedDateTime readonly [Symbol.toStringTag]: 'Temporal.Instant' } interface InstantConstructor { new (epochNanoseconds: bigint): Instant readonly prototype: Instant from(item: InstantLike): Instant fromEpochMilliseconds(epochMilliseconds: number): Instant fromEpochNanoseconds(epochNanoseconds: bigint): Instant compare(one: InstantLike, two: InstantLike): number } var Instant: InstantConstructor interface PlainYearMonthToPlainDateOptions { day: number } interface PlainYearMonth { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly daysInYear: number readonly daysInMonth: number readonly monthsInYear: number readonly inLeapYear: boolean with( yearMonthLike: PartialTemporalLike, options?: OverflowOptions, ): PlainYearMonth add(duration: DurationLike, options?: OverflowOptions): PlainYearMonth subtract(duration: DurationLike, options?: OverflowOptions): PlainYearMonth until( other: PlainYearMonthLike, options?: RoundingOptionsWithLargestUnit<'year' | 'month'>, ): Duration since( other: PlainYearMonthLike, options?: RoundingOptionsWithLargestUnit<'year' | 'month'>, ): Duration equals(other: PlainYearMonthLike): boolean toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toPlainDate(item: PlainYearMonthToPlainDateOptions): PlainDate readonly [Symbol.toStringTag]: 'Temporal.PlainYearMonth' } interface PlainYearMonthConstructor { new ( isoYear: number, isoMonth: number, calendar?: string, referenceISODay?: number, ): PlainYearMonth readonly prototype: PlainYearMonth from(item: PlainYearMonthLike, options?: OverflowOptions): PlainYearMonth compare(one: PlainYearMonthLike, two: PlainYearMonthLike): number } var PlainYearMonth: PlainYearMonthConstructor interface PlainMonthDayToPlainDateOptions { era?: string | undefined eraYear?: number | undefined year?: number | undefined } interface PlainMonthDay { readonly calendarId: string readonly monthCode: string readonly day: number with( monthDayLike: PartialTemporalLike, options?: OverflowOptions, ): PlainMonthDay equals(other: PlainMonthDayLike): boolean toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toPlainDate(item: PlainMonthDayToPlainDateOptions): PlainDate readonly [Symbol.toStringTag]: 'Temporal.PlainMonthDay' } interface PlainMonthDayConstructor { new ( isoMonth: number, isoDay: number, calendar?: string, referenceISOYear?: number, ): PlainMonthDay readonly prototype: PlainMonthDay from(item: PlainMonthDayLike, options?: OverflowOptions): PlainMonthDay } var PlainMonthDay: PlainMonthDayConstructor }", "jsdocSummary": "" }, { "subpath": ".", "name": "TimeAmount", "kind": "type", "signature": "export type TimeAmount = Readonly<{ hours?: number; minutes?: number; seconds?: number; milliseconds?: number; microseconds?: number; nanoseconds?: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "Timeline", "kind": "type", "signature": "export type Timeline = Instant | ZonedDateTime;", "jsdocSummary": "Points that identify an exact instant." }, { "subpath": ".", "name": "TimeParts", "kind": "type", "signature": "export type TimeParts = Readonly<{ hour: number; minute: number; second: number; millisecond: number; microsecond: number; nanosecond: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "TimeUnit", "kind": "type", "signature": "export type TimeUnit = 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond' | 'nanosecond';", "jsdocSummary": "" }, { "subpath": ".", "name": "toDate", "kind": "function", "signature": "export declare function toDate(value: Timeline | Date): Date;", "jsdocSummary": "A fresh mutable `Date` at the same instant (sub-millisecond precision truncated)." }, { "subpath": ".", "name": "today", "kind": "function", "signature": "export declare function today(options?: CurrentOptions): PlainDate;", "jsdocSummary": "Today's calendar date in a zone (runtime zone by default)." }, { "subpath": ".", "name": "toInstant", "kind": "function", "signature": "export declare function toInstant(value: Timeline | Date): Instant;", "jsdocSummary": "" }, { "subpath": ".", "name": "toISO", "kind": "function", "signature": "export declare function toISO(value: Point | Duration): string;", "jsdocSummary": "ISO 8601 text (`toString()` of the value)." }, { "subpath": ".", "name": "toISOInterval", "kind": "function", "signature": "export declare function toISOInterval(i: Interval): string;", "jsdocSummary": "ISO 8601 interval text: `start/end` (the end is exclusive)." }, { "subpath": ".", "name": "toMillis", "kind": "function", "signature": "export declare function toMillis(value: Timeline): number;", "jsdocSummary": "Milliseconds since the Unix epoch (sub-millisecond precision is truncated)." }, { "subpath": ".", "name": "toPickerDate", "kind": "function", "signature": "export declare function toPickerDate(value: PlainDate, basis?: DateBasis): Date;", "jsdocSummary": "A `Date` whose fields in the stated basis show the given calendar date (first valid time of that day). Throws if the day does not exist in that basis (a zone that skipped the date)." }, { "subpath": ".", "name": "toPlainDate", "kind": "function", "signature": "export declare function toPlainDate(value: Civil): PlainDate;", "jsdocSummary": "The calendar date of a civil value (a `ZonedDateTime` yields its date in its own zone)." }, { "subpath": ".", "name": "totalDuration", "kind": "function", "signature": "export declare function totalDuration(d: Duration, unit: Unit, options?: RelativeToOptions): number;", "jsdocSummary": "The whole duration expressed in one unit (fractional). `quarter` is months ÷ 3." }, { "subpath": ".", "name": "toUnits", "kind": "function", "signature": "export declare function toUnits(d: Duration, units: readonly DurationUnit[], options?: RelativeToOptions): Readonly>>;", "jsdocSummary": "Split a duration across `units` (distinct, largest first): every unit is a whole number except the last, which takes the fractional remainder. Without `relativeTo`, months never convert to days (throws `RangeError`)." }, { "subpath": ".", "name": "toUnix", "kind": "function", "signature": "export declare function toUnix(value: Timeline): number;", "jsdocSummary": "Whole seconds since the Unix epoch, floored." }, { "subpath": ".", "name": "toUTC", "kind": "function", "signature": "export declare function toUTC(value: Timeline | Date): ZonedDateTime;", "jsdocSummary": "The same instant in UTC." }, { "subpath": ".", "name": "tryParse", "kind": "function", "signature": "export declare function tryParse(text: string, kind: K): ParseResult;", "jsdocSummary": "Parse without throwing. The `kind` is explicit so a string is never reinterpreted." }, { "subpath": ".", "name": "tryParseDate", "kind": "function", "signature": "export declare function tryParseDate(text: string, pattern: string, options?: ParseOptions): PlainDate | undefined;", "jsdocSummary": "`parseDate` that returns `undefined` when the text does not match. A bad pattern still throws." }, { "subpath": ".", "name": "tryParseDateTime", "kind": "function", "signature": "export declare function tryParseDateTime(text: string, pattern: string, options?: ParseOptions): PlainDateTime | undefined;", "jsdocSummary": "`parseDateTime` that returns `undefined` when the text does not match. A bad pattern still throws." }, { "subpath": ".", "name": "tryParseZoned", "kind": "function", "signature": "export declare function tryParseZoned(text: string, pattern: string, timeZone: string, options?: ParseOptions & ZonedOptions): ZonedDateTime | undefined;", "jsdocSummary": "`parseZoned` that returns `undefined` when the text does not match or names a wall time that `disambiguation: 'reject'` refuses. A bad pattern or time zone still throws." }, { "subpath": ".", "name": "union", "kind": "function", "signature": "export declare function union(a: Interval, ...rest: readonly Interval>[]): readonly Interval[];", "jsdocSummary": "Everything covered by any of the intervals, as sorted disjoint pieces. Overlapping and touching intervals merge; a gap is never filled in." }, { "subpath": ".", "name": "Unit", "kind": "type", "signature": "export type Unit = CalendarUnit | TimeUnit;", "jsdocSummary": "" }, { "subpath": ".", "name": "UnitFor", "kind": "type", "signature": "export type UnitFor = Instant extends T ? PlainDate extends T ? never : TimeUnit : PlainDate extends T ? CalendarUnit : Unit;", "jsdocSummary": "The units a point type supports. For a union this is the intersection of its members' capabilities (`PlainDate | Instant` supports none — narrow first); for a generic `T extends Civil` use the calendar-unit overloads." }, { "subpath": ".", "name": "until", "kind": "function", "signature": "export declare function until(from: T, to: NoInfer, options: CalendarUntilOptions): Duration; ; export declare function until(from: T, to: NoInfer, options: UntilOptions>): Duration;", "jsdocSummary": "`to − from` as a balanced `Duration` (e.g. 1 month 3 days 4 hours)." }, { "subpath": ".", "name": "UntilOptions", "kind": "type", "signature": "export type UntilOptions = Readonly<{ largestUnit: Exclude, 'quarter'>; smallestUnit?: Exclude, 'quarter'>; roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "Wall", "kind": "type", "signature": "export type Wall = PlainDateTime | ZonedDateTime;", "jsdocSummary": "Points that carry a wall-clock time of day." }, { "subpath": ".", "name": "WallInput", "kind": "type", "signature": "export type WallInput = DateParts & Partial;", "jsdocSummary": "Date fields plus any subset of time fields (missing time fields are zero)." }, { "subpath": ".", "name": "WallParts", "kind": "type", "signature": "export type WallParts = DateParts & TimeParts;", "jsdocSummary": "" }, { "subpath": ".", "name": "Weekday", "kind": "type", "signature": "export type Weekday = 1 | 2 | 3 | 4 | 5 | 6 | 7;", "jsdocSummary": "ISO weekday: Monday = 1 … Sunday = 7 (same numbering as `Temporal.PlainDate#dayOfWeek`)." }, { "subpath": ".", "name": "WeekInfo", "kind": "type", "signature": "export type WeekInfo = Readonly<{ week: number; weekYear: number; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "weekOf", "kind": "function", "signature": "export declare function weekOf(value: Civil, rules?: WeekRules): WeekInfo;", "jsdocSummary": "Week number and the year that week belongs to, under the given rules (ISO by default). Returned together because the week-year differs from the calendar year around New Year." }, { "subpath": ".", "name": "WeekOptions", "kind": "type", "signature": "export type WeekOptions = Readonly<{ week?: WeekRules; }>;", "jsdocSummary": "" }, { "subpath": ".", "name": "WeekRules", "kind": "type", "signature": "export type WeekRules = Readonly<{ startsOn: Weekday; minimalDays: 1 | 2 | 3 | 4 | 5 | 6 | 7; }>;", "jsdocSummary": "How weeks are counted. `startsOn` is the first day of the week; `minimalDays` is how many days of January must fall in week 1 (ISO: Monday, 4)." }, { "subpath": ".", "name": "weekRulesFor", "kind": "function", "signature": "export declare function weekRulesFor(locale: string, fallback?: WeekRules): WeekRules;", "jsdocSummary": "The week rules a locale uses, from `Intl.Locale` week info (`en-US` → Sunday start, week 1 holds January 1; `de-DE` → ISO). Runtimes without week info (Node ≤ 22), or no `Intl.Locale` at all (Hermes), get `fallback`, ISO weeks by default." }, { "subpath": ".", "name": "weeks", "kind": "function", "signature": "export declare function weeks(n: number): Duration;", "jsdocSummary": "`n` weeks. `n` must be an integer." }, { "subpath": ".", "name": "weeksInYear", "kind": "function", "signature": "export declare function weeksInYear(year: number, rules?: WeekRules): number;", "jsdocSummary": "52 or 53." }, { "subpath": ".", "name": "years", "kind": "function", "signature": "export declare function years(n: number): Duration;", "jsdocSummary": "`n` years. `n` must be an integer." }, { "subpath": ".", "name": "zoned", "kind": "function", "signature": "export declare function zoned(input: string | ZonedDateTime, options?: ZonedOptions): ZonedDateTime; ; export declare function zoned(input: string | WallInput | PlainDateTime | PlainDate | Instant | ZonedDateTime | Date, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "An exact moment in a named zone." }, { "subpath": ".", "name": "ZonedDateTime", "kind": "type", "signature": "export type ZonedDateTime = Temporal.ZonedDateTime;", "jsdocSummary": "An exact moment projected into an IANA time zone — the everyday scheduling type." }, { "subpath": ".", "name": "ZonedOptions", "kind": "type", "signature": "export type ZonedOptions = Readonly<{ disambiguation?: Disambiguation; }>;", "jsdocSummary": "" }, { "subpath": "./business", "name": "addBusinessDays", "kind": "function", "signature": "export declare function addBusinessDays(value: T, count: number, calendar?: BusinessCalendar): T;", "jsdocSummary": "Move `count` business days forward (negative: backward). The start day is not counted, so Friday + 1 is Monday; `count` 0 returns `value` unchanged. Zoned values keep their wall-clock time. `count` must be a safe integer." }, { "subpath": "./business", "name": "businessCalendar", "kind": "function", "signature": "export declare function businessCalendar(options?: BusinessCalendarOptions): BusinessCalendar;", "jsdocSummary": "A validated business calendar. Weekend days are deduplicated and sorted; a weekend of all seven days is a `RangeError` (no day could ever be a business day). Holiday strings must be `YYYY-MM-DD` (validated with `plainDate()`)." }, { "subpath": "./business", "name": "BusinessCalendar", "kind": "type", "signature": "export type BusinessCalendar = Readonly<{ weekend: readonly Weekday[]; holidays: ReadonlySet; }>;", "jsdocSummary": "Which weekdays are off and which dates are holidays. `holidays` holds ISO `YYYY-MM-DD` strings. The record and its `weekend` list are frozen; build a new calendar with `businessCalendar()` rather than changing one." }, { "subpath": "./business", "name": "BusinessCalendarOptions", "kind": "type", "signature": "export type BusinessCalendarOptions = Readonly<{ /** ISO weekdays that are off (Monday = 1 … Sunday = 7). Default `[6, 7]`. */ weekend?: readonly Weekday[]; /** Days off, as `PlainDate`s or `YYYY-MM-DD` strings. */ holidays?: Iterable; }>;", "jsdocSummary": "" }, { "subpath": "./business", "name": "businessDaysBetween", "kind": "function", "signature": "export declare function businessDaysBetween(from: PlainDate, to: PlainDate, calendar?: BusinessCalendar): number;", "jsdocSummary": "Business days in `[from, to)`. Reversed arguments give the negated count: `businessDaysBetween(a, b) === -businessDaysBetween(b, a)`." }, { "subpath": "./business", "name": "businessDaysIn", "kind": "function", "signature": "export declare function businessDaysIn(i: Interval, calendar?: BusinessCalendar): number;", "jsdocSummary": "Business days inside a `PlainDate` interval (its end is exclusive)." }, { "subpath": "./business", "name": "DEFAULT_BUSINESS_CALENDAR", "kind": "variable", "signature": "export declare const DEFAULT_BUSINESS_CALENDAR: BusinessCalendar;", "jsdocSummary": "Saturday and Sunday off, no holidays." }, { "subpath": "./business", "name": "isBusinessDay", "kind": "function", "signature": "export declare function isBusinessDay(value: Civil, calendar?: BusinessCalendar): boolean;", "jsdocSummary": "Is the value's date neither a weekend day nor a holiday?" }, { "subpath": "./business", "name": "nextBusinessDay", "kind": "function", "signature": "export declare function nextBusinessDay(value: T, calendar?: BusinessCalendar): T;", "jsdocSummary": "The first business day strictly after `value` (same wall-clock time for zoned values)." }, { "subpath": "./business", "name": "previousBusinessDay", "kind": "function", "signature": "export declare function previousBusinessDay(value: T, calendar?: BusinessCalendar): T;", "jsdocSummary": "The last business day strictly before `value` (same wall-clock time for zoned values)." }, { "subpath": "./business", "name": "subBusinessDays", "kind": "function", "signature": "export declare function subBusinessDays(value: T, count: number, calendar?: BusinessCalendar): T;", "jsdocSummary": "Move `count` business days backward: `addBusinessDays(value, -count)`." }, { "subpath": "./calendar", "name": "age", "kind": "function", "signature": "export declare function age(birthDate: PlainDate, asOf: PlainDate, options?: AgeOptions): number;", "jsdocSummary": "Completed years between a birth date and `asOf`. Throws if `asOf` is before the birth date." }, { "subpath": "./calendar", "name": "AgeOptions", "kind": "type", "signature": "export type AgeOptions = Readonly<{ /** When a Feb 29 birthday is celebrated in common years. Default `feb28`. */ leapDay?: 'feb28' | 'mar1'; }>;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "calendarDaysBetween", "kind": "function", "signature": "export declare function calendarDaysBetween(from: PlainDate, to: PlainDate): number;", "jsdocSummary": "Whole calendar days from `from` to `to` (negative when reversed). Counts date boundaries, not elapsed hours." }, { "subpath": "./calendar", "name": "dayOfWeek", "kind": "function", "signature": "export declare function dayOfWeek(value: Civil): Weekday;", "jsdocSummary": "ISO weekday, Monday = 1 … Sunday = 7." }, { "subpath": "./calendar", "name": "dayOfYear", "kind": "function", "signature": "export declare function dayOfYear(value: Civil): number;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "daysInMonth", "kind": "function", "signature": "export declare function daysInMonth(value: Civil): number;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "daysInYear", "kind": "function", "signature": "export declare function daysInYear(value: Civil): number;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "DEFAULT_WEEKEND", "kind": "variable", "signature": "export declare const DEFAULT_WEEKEND: readonly Weekday[];", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "easter", "kind": "function", "signature": "export declare function easter(year: number, rite?: EasterRite): PlainDate;", "jsdocSummary": "Easter Sunday of a year. `'western'` is the Gregorian computus (Meeus/ Jones/Butcher); `'orthodox'` is the Julian computus (Meeus) converted to the ISO calendar, so both results are dates you can compare and add to directly. Movable feasts are offsets: Good Friday is `-2` days, Pentecost `+49`." }, { "subpath": "./calendar", "name": "EasterRite", "kind": "type", "signature": "export type EasterRite = 'western' | 'orthodox';", "jsdocSummary": "`'western'` (Gregorian computus) or `'orthodox'` (Julian computus, shown on the ISO calendar)." }, { "subpath": "./calendar", "name": "isLeapYear", "kind": "function", "signature": "export declare function isLeapYear(value: Civil | number): boolean;", "jsdocSummary": "Gregorian leap-year rule, for a value or a bare year number." }, { "subpath": "./calendar", "name": "isoWeek", "kind": "function", "signature": "export declare function isoWeek(value: Civil): WeekInfo;", "jsdocSummary": "ISO 8601 week and week-year." }, { "subpath": "./calendar", "name": "isWeekday", "kind": "function", "signature": "export declare function isWeekday(value: Civil, weekend?: readonly Weekday[]): boolean;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "isWeekend", "kind": "function", "signature": "export declare function isWeekend(value: Civil, weekend?: readonly Weekday[]): boolean;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "lastWeekdayOfMonth", "kind": "function", "signature": "export declare function lastWeekdayOfMonth(year: number, month: number, weekday: Weekday): PlainDate;", "jsdocSummary": "The last `weekday` of a month: `nthWeekdayOfMonth(year, month, -1, weekday)`." }, { "subpath": "./calendar", "name": "nthWeekdayOfMonth", "kind": "function", "signature": "export declare function nthWeekdayOfMonth(year: number, month: number, n: number, weekday: Weekday): PlainDate;", "jsdocSummary": "The n-th `weekday` of a month: `nthWeekdayOfMonth(2026, 5, 2, 5)` is the second Friday of May 2026. Negative `n` counts from the end (`-1` = last). A `RangeError` when the month has no such day (a fifth Monday, say)." }, { "subpath": "./calendar", "name": "quarter", "kind": "function", "signature": "export declare function quarter(value: Civil): 1 | 2 | 3 | 4;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "WeekInfo", "kind": "type", "signature": "export type WeekInfo = Readonly<{ week: number; weekYear: number; }>;", "jsdocSummary": "" }, { "subpath": "./calendar", "name": "weekOf", "kind": "function", "signature": "export declare function weekOf(value: Civil, rules?: WeekRules): WeekInfo;", "jsdocSummary": "Week number and the year that week belongs to, under the given rules (ISO by default). Returned together because the week-year differs from the calendar year around New Year." }, { "subpath": "./calendar", "name": "weekRulesFor", "kind": "function", "signature": "export declare function weekRulesFor(locale: string, fallback?: WeekRules): WeekRules;", "jsdocSummary": "The week rules a locale uses, from `Intl.Locale` week info (`en-US` → Sunday start, week 1 holds January 1; `de-DE` → ISO). Runtimes without week info (Node ≤ 22), or no `Intl.Locale` at all (Hermes), get `fallback`, ISO weeks by default." }, { "subpath": "./calendar", "name": "weeksInYear", "kind": "function", "signature": "export declare function weeksInYear(year: number, rules?: WeekRules): number;", "jsdocSummary": "52 or 53." }, { "subpath": "./clock", "name": "ClockOptions", "kind": "type", "signature": "export type ClockOptions = Readonly<{ clock?: Clock; }>;", "jsdocSummary": "Which clock to read. Default: the system clock." }, { "subpath": "./clock", "name": "CurrentOptions", "kind": "type", "signature": "export type CurrentOptions = ClockOptions & Readonly<{ timeZone?: string; week?: WeekRules; }>;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isFuture", "kind": "function", "signature": "export declare function isFuture(value: Timeline | Date, options?: ClockOptions): boolean;", "jsdocSummary": "Strictly after now." }, { "subpath": "./clock", "name": "isPast", "kind": "function", "signature": "export declare function isPast(value: Timeline | Date, options?: ClockOptions): boolean;", "jsdocSummary": "Strictly before now." }, { "subpath": "./clock", "name": "isThisMonth", "kind": "function", "signature": "export declare function isThisMonth(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isThisWeek", "kind": "function", "signature": "export declare function isThisWeek(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isThisYear", "kind": "function", "signature": "export declare function isThisYear(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isToday", "kind": "function", "signature": "export declare function isToday(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isTomorrow", "kind": "function", "signature": "export declare function isTomorrow(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "isYesterday", "kind": "function", "signature": "export declare function isYesterday(value: Point, options?: CurrentOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./clock", "name": "now", "kind": "function", "signature": "export declare function now(options?: ClockOptions): Instant;", "jsdocSummary": "The current instant." }, { "subpath": "./clock", "name": "nowIn", "kind": "function", "signature": "export declare function nowIn(options?: CurrentOptions): ZonedDateTime;", "jsdocSummary": "The current moment in a zone (runtime zone by default)." }, { "subpath": "./clock", "name": "today", "kind": "function", "signature": "export declare function today(options?: CurrentOptions): PlainDate;", "jsdocSummary": "Today's calendar date in a zone (runtime zone by default)." }, { "subpath": "./compare", "name": "BucketUnitFor", "kind": "type", "signature": "export type BucketUnitFor = PlainDate extends T ? CalendarUnit : Unit;", "jsdocSummary": "Units a value can be bucketed by: instants may use calendar units once projected into `timeZone`." }, { "subpath": "./compare", "name": "clamp", "kind": "function", "signature": "export declare function clamp(value: T, minimum: NoInfer, maximum: NoInfer): T;", "jsdocSummary": "`value` limited to `[minimum, maximum]`." }, { "subpath": "./compare", "name": "compareAsc", "kind": "function", "signature": "export declare function compareAsc(a: T, b: NoInfer): Ordering;", "jsdocSummary": "`-1` when `a` is earlier, `1` when later, `0` when equal. Usable directly as an `Array#sort` comparator." }, { "subpath": "./compare", "name": "compareDesc", "kind": "function", "signature": "export declare function compareDesc(a: T, b: NoInfer): Ordering;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "equals", "kind": "function", "signature": "export declare function equals(a: T, b: NoInfer): boolean;", "jsdocSummary": "Field-for-field equality (for zoned values: same instant *and* same zone)." }, { "subpath": "./compare", "name": "isAfter", "kind": "function", "signature": "export declare function isAfter(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isBefore", "kind": "function", "signature": "export declare function isBefore(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isBetween", "kind": "function", "signature": "export declare function isBetween(value: T, start: NoInfer, end: NoInfer, options?: Readonly<{ bounds?: Bounds; }>): boolean;", "jsdocSummary": "Is `value` inside `[start, end)` (or the given `bounds`)? Reversed bounds throw." }, { "subpath": "./compare", "name": "isSame", "kind": "function", "signature": "export declare function isSame(a: T, b: NoInfer, unit: BucketUnitFor>, options?: SameOptions): boolean; ; export declare function isSame(a: Instant, b: Instant, unit: Unit, options: SameOptions & { timeZone: string; }): boolean; ; export declare function isSame(a: T, b: NoInfer, unit: BucketUnitFor>, options?: SameOptions): boolean;", "jsdocSummary": "Do both values fall in the same calendar unit (day, ISO week, month, quarter, year, hour…)?" }, { "subpath": "./compare", "name": "isSameDay", "kind": "function", "signature": "export declare function isSameDay(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameMonth", "kind": "function", "signature": "export declare function isSameMonth(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameOrAfter", "kind": "function", "signature": "export declare function isSameOrAfter(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameOrBefore", "kind": "function", "signature": "export declare function isSameOrBefore(a: T, b: NoInfer): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameQuarter", "kind": "function", "signature": "export declare function isSameQuarter(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameWeek", "kind": "function", "signature": "export declare function isSameWeek(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "isSameYear", "kind": "function", "signature": "export declare function isSameYear(a: T, b: NoInfer, options?: SameOptions): boolean;", "jsdocSummary": "" }, { "subpath": "./compare", "name": "max", "kind": "function", "signature": "export declare function max(values: readonly [T, ...T[]]): T;", "jsdocSummary": "The latest of the given values." }, { "subpath": "./compare", "name": "min", "kind": "function", "signature": "export declare function min(values: readonly [T, ...T[]]): T;", "jsdocSummary": "The earliest of the given values (one of the inputs, not a copy)." }, { "subpath": "./compare", "name": "sameInstant", "kind": "function", "signature": "export declare function sameInstant(a: Timeline | Date, b: Timeline | Date): boolean;", "jsdocSummary": "Do two timeline values point at the same instant, whatever their zones?" }, { "subpath": "./compare", "name": "SameOptions", "kind": "type", "signature": "export type SameOptions = Readonly<{ week?: WeekRules; /** Zone in which to bucket. Required for instants; required for zoned values in different zones. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": "./core", "name": "fromMillis", "kind": "function", "signature": "export declare function fromMillis(milliseconds: number): Instant;", "jsdocSummary": "Unix time in whole milliseconds (the `Date.now()` convention)." }, { "subpath": "./core", "name": "fromUnix", "kind": "function", "signature": "export declare function fromUnix(seconds: number): Instant;", "jsdocSummary": "Unix time in seconds (fractions allowed, kept to nanosecond precision)." }, { "subpath": "./core", "name": "instant", "kind": "function", "signature": "export declare function instant(input: string | Date | Timeline): Instant;", "jsdocSummary": "An exact moment. Strings must carry `Z` or an offset; `Date` is copied by its epoch milliseconds." }, { "subpath": "./core", "name": "parseISO", "kind": "function", "signature": "export declare function parseISO(text: string, options?: ParseISOOptions): Instant;", "jsdocSummary": "Read lenient ISO 8601 text — everything `instant()` accepts plus the forms people actually send: `2026-05-20` (midnight), `2026-05`, `2026`, basic `20260520T1030`, week dates `2026-W41-5`, ordinal dates `2026-283`, a fraction on the last time unit, `24:00`, `±HH` offsets." }, { "subpath": "./core", "name": "ParseISOOptions", "kind": "type", "signature": "export type ParseISOOptions = Readonly<{ /** Zone for text without an offset. Default: the runtime zone. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": "./core", "name": "ParseKinds", "kind": "type", "signature": "export type ParseKinds = { plainDate: PlainDate; plainDateTime: PlainDateTime; zoned: ZonedDateTime; instant: Instant; duration: Duration; /** Lenient ISO text via `parseISO`. */ iso: Instant; };", "jsdocSummary": "" }, { "subpath": "./core", "name": "ParseResult", "kind": "type", "signature": "export type ParseResult = { readonly ok: true; readonly value: T; } | { readonly ok: false; readonly error: RangeError; };", "jsdocSummary": "" }, { "subpath": "./core", "name": "plainDate", "kind": "function", "signature": "export declare function plainDate(input: string | DateParts | Civil): PlainDate;", "jsdocSummary": "A calendar date. Accepts `YYYY-MM-DD` only — a timestamp string is rejected so that a zone and time are never silently dropped. Pass a `ZonedDateTime` when you really mean \"the date this moment falls on in its zone\"." }, { "subpath": "./core", "name": "plainDateTime", "kind": "function", "signature": "export declare function plainDateTime(input: string | WallInput | Wall): PlainDateTime;", "jsdocSummary": "A wall-clock date and time with no zone. Strings carrying an offset or zone are rejected." }, { "subpath": "./core", "name": "toInstant", "kind": "function", "signature": "export declare function toInstant(value: Timeline | Date): Instant;", "jsdocSummary": "" }, { "subpath": "./core", "name": "toISO", "kind": "function", "signature": "export declare function toISO(value: Point | Duration): string;", "jsdocSummary": "ISO 8601 text (`toString()` of the value)." }, { "subpath": "./core", "name": "toMillis", "kind": "function", "signature": "export declare function toMillis(value: Timeline): number;", "jsdocSummary": "Milliseconds since the Unix epoch (sub-millisecond precision is truncated)." }, { "subpath": "./core", "name": "toPlainDate", "kind": "function", "signature": "export declare function toPlainDate(value: Civil): PlainDate;", "jsdocSummary": "The calendar date of a civil value (a `ZonedDateTime` yields its date in its own zone)." }, { "subpath": "./core", "name": "toUnix", "kind": "function", "signature": "export declare function toUnix(value: Timeline): number;", "jsdocSummary": "Whole seconds since the Unix epoch, floored." }, { "subpath": "./core", "name": "tryParse", "kind": "function", "signature": "export declare function tryParse(text: string, kind: K): ParseResult;", "jsdocSummary": "Parse without throwing. The `kind` is explicit so a string is never reinterpreted." }, { "subpath": "./core", "name": "zoned", "kind": "function", "signature": "export declare function zoned(input: string | ZonedDateTime, options?: ZonedOptions): ZonedDateTime; ; export declare function zoned(input: string | WallInput | PlainDateTime | PlainDate | Instant | ZonedDateTime | Date, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "An exact moment in a named zone." }, { "subpath": "./core", "name": "ZonedOptions", "kind": "type", "signature": "export type ZonedOptions = Readonly<{ disambiguation?: Disambiguation; }>;", "jsdocSummary": "" }, { "subpath": "./duration", "name": "absDuration", "kind": "function", "signature": "export declare function absDuration(d: Duration): Duration;", "jsdocSummary": "The duration with every field made non-negative." }, { "subpath": "./duration", "name": "addDuration", "kind": "function", "signature": "export declare function addDuration(a: Duration, b: Duration): Duration;", "jsdocSummary": "`a + b` by field groups: (years, months) as months, (weeks, days) as days, (hours…ns) exactly. Groups never carry into each other; weeks survive only when neither input has days. Throws `RangeError` when groups end with mixed signs." }, { "subpath": "./duration", "name": "compareDurations", "kind": "function", "signature": "export declare function compareDurations(a: Duration, b: Duration, options?: RelativeToOptions): Ordering;", "jsdocSummary": "`-1`, `0` or `1` by length. Calendar units need `relativeTo` (`P1M` vs `P30D` depends on the month)." }, { "subpath": "./duration", "name": "days", "kind": "function", "signature": "export declare function days(n: number): Duration;", "jsdocSummary": "`n` calendar days. `n` must be an integer." }, { "subpath": "./duration", "name": "duration", "kind": "function", "signature": "export declare function duration(input: string | Amount | Duration): Duration;", "jsdocSummary": "A `Duration` from an ISO 8601 string (`P1DT2H`), an `Amount` (quarters become 3 months) or a `Duration` (returned as-is)." }, { "subpath": "./duration", "name": "DurationIntlOptions", "kind": "type", "signature": "export type DurationIntlOptions = Readonly<{ locale?: string; }> & Readonly;", "jsdocSummary": "" }, { "subpath": "./duration", "name": "formatDurationIntl", "kind": "function", "signature": "export declare function formatDurationIntl(d: Duration, options?: DurationIntlOptions): string;", "jsdocSummary": "Locale-native duration text through `Intl.DurationFormat`: `formatDurationIntl(d, { style: 'short' })` → `1 hr, 30 min` (en-US), with proper plurals in every locale. Unlike `humanizeDuration` the text depends on the runtime's ICU data, and engines without `Intl.DurationFormat` (Hermes, Node ≤ 22) throw a `RangeError` — use `humanizeDuration` when every runtime must print the same text." }, { "subpath": "./duration", "name": "formatDurationISO", "kind": "function", "signature": "export declare function formatDurationISO(d: Duration): string;", "jsdocSummary": "ISO 8601 duration text, e.g. `P1DT2H`." }, { "subpath": "./duration", "name": "hours", "kind": "function", "signature": "export declare function hours(n: number): Duration;", "jsdocSummary": "`n` hours. `n` must be an integer." }, { "subpath": "./duration", "name": "humanizeDuration", "kind": "function", "signature": "export declare function humanizeDuration(d: Duration, options?: HumanizeOptions): string;", "jsdocSummary": "Locale text such as \"1 day and 2 hours\" (`Intl.NumberFormat` units joined by `Intl.ListFormat`). Zero-valued units are skipped; a negative duration is the absolute text prefixed with `-`; a zero duration prints 0 of the smallest unit." }, { "subpath": "./duration", "name": "HumanizeOptions", "kind": "type", "signature": "export type HumanizeOptions = Readonly<{ locale?: string; units?: readonly DurationUnit[]; style?: 'long' | 'short' | 'narrow'; /** Keep only the N largest nonzero units; the rest is dropped, not rounded. */ maximumUnits?: number; relativeTo?: PlainDate | ZonedDateTime; }>;", "jsdocSummary": "" }, { "subpath": "./duration", "name": "isNegativeDuration", "kind": "function", "signature": "export declare function isNegativeDuration(d: Duration): boolean;", "jsdocSummary": "True when the duration points backward (any field is negative)." }, { "subpath": "./duration", "name": "isZeroDuration", "kind": "function", "signature": "export declare function isZeroDuration(d: Duration): boolean;", "jsdocSummary": "True when every field is zero." }, { "subpath": "./duration", "name": "milliseconds", "kind": "function", "signature": "export declare function milliseconds(n: number): Duration;", "jsdocSummary": "`n` milliseconds. `n` must be an integer." }, { "subpath": "./duration", "name": "minutes", "kind": "function", "signature": "export declare function minutes(n: number): Duration;", "jsdocSummary": "`n` minutes. `n` must be an integer." }, { "subpath": "./duration", "name": "months", "kind": "function", "signature": "export declare function months(n: number): Duration;", "jsdocSummary": "`n` months. `n` must be an integer." }, { "subpath": "./duration", "name": "multiplyDuration", "kind": "function", "signature": "export declare function multiplyDuration(d: Duration, factor: number): Duration;", "jsdocSummary": "Every field times `factor` (a safe integer). Fields are scaled as-is, never re-balanced." }, { "subpath": "./duration", "name": "negateDuration", "kind": "function", "signature": "export declare function negateDuration(d: Duration): Duration;", "jsdocSummary": "The same duration pointing the other way." }, { "subpath": "./duration", "name": "normalizeDuration", "kind": "function", "signature": "export declare function normalizeDuration(d: Duration, options: NormalizeOptions): Duration;", "jsdocSummary": "Re-balance across units with Temporal's `Duration#round`. Calendar units (years, months, weeks) need `relativeTo`; without it a day counts as 24 hours." }, { "subpath": "./duration", "name": "NormalizeOptions", "kind": "type", "signature": "export type NormalizeOptions = Readonly<{ largestUnit: DurationUnit; smallestUnit?: DurationUnit; relativeTo?: PlainDate | ZonedDateTime; /** Temporal's default (`halfExpand`) when omitted. */ roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": "./duration", "name": "RelativeToOptions", "kind": "type", "signature": "export type RelativeToOptions = Readonly<{ relativeTo?: PlainDate | ZonedDateTime; }>;", "jsdocSummary": "The anchor Temporal needs to measure calendar units (months have 28–31 days, days 23–25 hours)." }, { "subpath": "./duration", "name": "seconds", "kind": "function", "signature": "export declare function seconds(n: number): Duration;", "jsdocSummary": "`n` seconds. `n` must be an integer." }, { "subpath": "./duration", "name": "subDuration", "kind": "function", "signature": "export declare function subDuration(a: Duration, b: Duration): Duration;", "jsdocSummary": "`a − b` with the same group policy as `addDuration` (`P1Y − P2M` = `P10M`; `P1D − PT1H` throws)." }, { "subpath": "./duration", "name": "totalDuration", "kind": "function", "signature": "export declare function totalDuration(d: Duration, unit: Unit, options?: RelativeToOptions): number;", "jsdocSummary": "The whole duration expressed in one unit (fractional). `quarter` is months ÷ 3." }, { "subpath": "./duration", "name": "toUnits", "kind": "function", "signature": "export declare function toUnits(d: Duration, units: readonly DurationUnit[], options?: RelativeToOptions): Readonly>>;", "jsdocSummary": "Split a duration across `units` (distinct, largest first): every unit is a whole number except the last, which takes the fractional remainder. Without `relativeTo`, months never convert to days (throws `RangeError`)." }, { "subpath": "./duration", "name": "weeks", "kind": "function", "signature": "export declare function weeks(n: number): Duration;", "jsdocSummary": "`n` weeks. `n` must be an integer." }, { "subpath": "./duration", "name": "years", "kind": "function", "signature": "export declare function years(n: number): Duration;", "jsdocSummary": "`n` years. `n` must be an integer." }, { "subpath": "./fluent", "name": "createDateContext", "kind": "function", "signature": "export declare function createDateContext(options?: DateContextOptions): DateContext;", "jsdocSummary": "" }, { "subpath": "./fluent", "name": "date", "kind": "function", "signature": "export declare function date(input: DateLike, options?: DateContextOptions): DateValue;", "jsdocSummary": "Wrap a moment for fluent use. A `Date`, `Instant` or offset string is projected into `options.timeZone` (runtime zone by default); a `ZonedDateTime` or `[Zone]`-annotated string keeps its own zone." }, { "subpath": "./fluent", "name": "DateContext", "kind": "type", "signature": "export type DateContext = Readonly<{ timeZone: string; locale: string; week: WeekRules; clock: Clock; /** The current moment in the context zone. */ now(): DateValue; /** Today's calendar date in the context zone. */ today(): PlainDate; date(input: DateLike): DateValue; isToday(value: Point): boolean; isPast(value: Instant | ZonedDateTime | Date): boolean; isFuture(value: Instant | ZonedDateTime | Date): boolean; }>;", "jsdocSummary": "A `date()` factory with zone, locale, week rules and clock bound once (inject a `MockClock` in tests)." }, { "subpath": "./fluent", "name": "DateContextOptions", "kind": "type", "signature": "export type DateContextOptions = Readonly<{ timeZone?: string; locale?: string; week?: WeekRules; clock?: Clock; }>;", "jsdocSummary": "" }, { "subpath": "./fluent", "name": "DateLike", "kind": "type", "signature": "export type DateLike = DateValue | ZonedDateTime | Instant | Date | string;", "jsdocSummary": "Anything a `DateValue` method accepts as \"the other moment\"." }, { "subpath": "./fluent", "name": "DateValue", "kind": "class", "signature": "export declare class DateValue { #private; constructor(value: ZonedDateTime, settings: Settings); /** The underlying immutable `ZonedDateTime`. */ value(): ZonedDateTime; toInstant(): Instant; toPlainDate(): PlainDate; toPlainDateTime(): PlainDateTime; /** A fresh mutable `Date` at this instant. */ toDate(): Date; toISO(): string; toString(): string; toJSON(): string; /** Numeric coercion is a bug waiting to happen; use `toInstant().epochMilliseconds`. */ [Symbol.toPrimitive](hint: string): string; get timeZoneId(): string; get locale(): string; get year(): number; get month(): number; get day(): number; get hour(): number; get minute(): number; get second(): number; get epochMilliseconds(): number; parts(): WallParts; add(amount: Amount | Duration, options?: ArithmeticOptions): DateValue; sub(amount: Amount | Duration, options?: ArithmeticOptions): DateValue; set(patch: Partial>, options?: SetOptions): DateValue; startOf(unit: Unit): DateValue; endOf(unit: Unit): DateValue; nextBoundary(unit: Unit): DateValue; floor(unit: Unit, options?: RoundOptions): DateValue; ceil(unit: Unit, options?: RoundOptions): DateValue; round(unit: Unit, options?: RoundOptions): DateValue; /** `other − this` in whole units (see `diff`). */ diff(other: DateLike, unit: Unit, options?: DiffOptions): number; until(other: DateLike, options: UntilOptions): Duration; /** Exact elapsed time to `other` (a day is 24 h here). */ diffElapsed(other: DateLike, unit: TimeUnit | 'day' | 'week', options?: DiffOptions): number; equals(other: DateLike): boolean; sameInstant(other: DateLike): boolean; compare(other: DateLike): -1 | 0 | 1; isBefore(other: DateLike): boolean; isAfter(other: DateLike): boolean; isSameOrBefore(other: DateLike): boolean; isSameOrAfter(other: DateLike): boolean; isSame(other: DateLike, unit: Unit, options?: SameOptions): boolean; isSameDay(other: DateLike): boolean; isSameWeek(other: DateLike): boolean; isSameMonth(other: DateLike): boolean; isSameYear(other: DateLike): boolean; isBetween(start: DateLike, end: DateLike, options?: Readonly<{ bounds?: Bounds; }>): boolean; clamp(minimum: DateLike, maximum: DateLike): DateValue; isToday(): boolean; isTomorrow(): boolean; isYesterday(): boolean; isThisWeek(): boolean; isThisMonth(): boolean; isThisYear(): boolean; isPast(): boolean; isFuture(): boolean; /** \"3 days ago\" / \"in 2 hours\" relative to the context clock. */ fromNow(options?: RelativeOptions): string; dayOfWeek(): Weekday; dayOfYear(): number; daysInMonth(): number; isLeapYear(): boolean; isWeekend(weekend?: readonly Weekday[]): boolean; isWeekday(weekend?: readonly Weekday[]): boolean; isoWeek(): WeekInfo; weekOf(rules?: WeekRules): WeekInfo; quarter(): 1 | 2 | 3 | 4; /** Same instant, another zone. */ inZone(timeZone: string): DateValue; /** Same wall clock, another zone (the instant changes). */ reinterpretZone(timeZone: string, options?: ZonedOptions): DateValue; toUTC(): DateValue; offset(): string; isBusinessDay(calendar?: BusinessCalendar): boolean; addBusinessDays(count: number, calendar?: BusinessCalendar): DateValue; subBusinessDays(count: number, calendar?: BusinessCalendar): DateValue; nextBusinessDay(calendar?: BusinessCalendar): DateValue; previousBusinessDay(calendar?: BusinessCalendar): DateValue; /** Token formatting (`'yyyy-MM-dd HH:mm'`) in the context locale. */ format(pattern: string, options?: FormatOptions): string; /** `Intl.DateTimeFormat` formatting in the context locale. */ formatIntl(options?: FormatIntlOptions): string; /** \"3 days ago\" / \"in 2 hours\" relative to `reference`. */ relativeTo(reference: DateLike, options?: RelativeOptions): string; /** Apply any function to the underlying value; a `ZonedDateTime` result is re-wrapped. */ pipe(fn: (value: ZonedDateTime) => R): R extends ZonedDateTime ? DateValue : R; }", "jsdocSummary": "An immutable moment in a zone with chainable operations. Create one with `date()`." }, { "subpath": "./format", "name": "format", "kind": "function", "signature": "export declare function format(value: Point | Date, pattern: string, options?: FormatOptions): string;", "jsdocSummary": "Format with a Unicode LDML pattern, producing the same text as date-fns v4 `format` (en-US) for the supported tokens." }, { "subpath": "./format", "name": "formatIntl", "kind": "function", "signature": "export declare function formatIntl(value: Point | Date, options?: FormatIntlOptions): string;", "jsdocSummary": "Locale-native output through `Intl.DateTimeFormat` (`dateStyle`, `month: 'long'`, …)." }, { "subpath": "./format", "name": "FormatIntlOptions", "kind": "type", "signature": "export type FormatIntlOptions = Readonly & FormatOptions;", "jsdocSummary": "`Intl.DateTimeFormat` options plus this package's `locale` / `timeZone`." }, { "subpath": "./format", "name": "formatISO", "kind": "function", "signature": "export declare function formatISO(value: Point | Duration): string;", "jsdocSummary": "ISO 8601 / RFC 9557 text: the value's `toString()` (`2026-05-20`, `PT1H30M`, `…+03:00[Europe/Bucharest]`)." }, { "subpath": "./format", "name": "FormatOptions", "kind": "type", "signature": "export type FormatOptions = Readonly<{ locale?: string; timeZone?: string; }>;", "jsdocSummary": "Locale (BCP 47, default `'en-US'`) and time zone (IANA id) for formatting." }, { "subpath": "./format", "name": "formatRange", "kind": "function", "signature": "export declare function formatRange(start: Point | Date, end: Point | Date, options?: FormatIntlOptions): string;", "jsdocSummary": "Locale text for a span, through `Intl.DateTimeFormat#formatRange`: `formatRange(plainDate('2026-05-20'), plainDate('2026-05-24'), { dateStyle: 'medium' })` → `May 20 – 24, 2026`. Both ends follow the same rules as `formatIntl` and must be the same kind of value; the end may precede the start. Engines without `formatRange` (Hermes V1) throw a `RangeError`." }, { "subpath": "./interop", "name": "DateBasis", "kind": "type", "signature": "export type DateBasis = { readonly basis: 'local'; } | { readonly basis: 'utc'; } | { readonly basis: 'zone'; readonly timeZone: string; };", "jsdocSummary": "Which clock a `Date`'s calendar fields were chosen in. Browser pickers that build `new Date(y, m, d)` use `local`; APIs that build `Date.UTC(...)` use `utc`." }, { "subpath": "./interop", "name": "fromDate", "kind": "function", "signature": "export declare function fromDate(value: Date): Instant;", "jsdocSummary": "The instant a `Date` represents." }, { "subpath": "./interop", "name": "fromPickerDate", "kind": "function", "signature": "export declare function fromPickerDate(value: Date, basis?: DateBasis): PlainDate;", "jsdocSummary": "The calendar date a picker selected, read from the `Date`'s fields in the stated basis." }, { "subpath": "./interop", "name": "systemTimeZone", "kind": "function", "signature": "export declare function systemTimeZone(): string;", "jsdocSummary": "The runtime's IANA time zone (e.g. `Europe/Bucharest`). The lookup costs ~0.2 ms on the polyfill, so the answer is reused for one second; the zone can change at runtime (`process.env.TZ`, a travelling laptop) and a change shows up within that second." }, { "subpath": "./interop", "name": "toDate", "kind": "function", "signature": "export declare function toDate(value: Timeline | Date): Date;", "jsdocSummary": "A fresh mutable `Date` at the same instant (sub-millisecond precision truncated)." }, { "subpath": "./interop", "name": "toPickerDate", "kind": "function", "signature": "export declare function toPickerDate(value: PlainDate, basis?: DateBasis): Date;", "jsdocSummary": "A `Date` whose fields in the stated basis show the given calendar date (first valid time of that day). Throws if the day does not exist in that basis (a zone that skipped the date)." }, { "subpath": "./interval", "name": "abuts", "kind": "function", "signature": "export declare function abuts(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Does one interval end exactly where the other starts (`a.end == b.start` or `b.end == a.start`)?" }, { "subpath": "./interval", "name": "contains", "kind": "function", "signature": "export declare function contains(i: Interval, value: NoInfer | Interval>): boolean;", "jsdocSummary": "For a point: `start ≤ value < end`. For an interval: `b` lies entirely inside `i` (`i.start ≤ b.start` and `b.end ≤ i.end`); an empty `b` inside `i` counts." }, { "subpath": "./interval", "name": "each", "kind": "function", "signature": "export declare function each(i: Interval, step: AmountFor>, options?: IterateOptions): IterableIterator;", "jsdocSummary": "`start`, `start + step`, `start + 2 × step` … while before `end`. Each value is anchored at `start` (`add(start, step × n)`), never accumulated, so a monthly walk from Jan 31 gives Jan 31, Feb 28, Mar 31, Apr 30. The step needs a nonzero field and no negative ones (`RangeError` otherwise)." }, { "subpath": "./interval", "name": "gap", "kind": "function", "signature": "export declare function gap(a: Interval, b: Interval>): Interval | null;", "jsdocSummary": "The interval strictly between two separated intervals, or `null` when they overlap or touch." }, { "subpath": "./interval", "name": "gapsBetween", "kind": "function", "signature": "export declare function gapsBetween(list: readonly Interval[]): readonly Interval[];", "jsdocSummary": "The holes between the merged intervals, in order (empty when they form one block)." }, { "subpath": "./interval", "name": "intersection", "kind": "function", "signature": "export declare function intersection(a: Interval, b: Interval>): Interval | null;", "jsdocSummary": "The points in both intervals, or `null` when they share none." }, { "subpath": "./interval", "name": "interval", "kind": "function", "signature": "export declare function interval(start: T, end: NoInfer, options?: IntervalOptions): Interval;", "jsdocSummary": "A half-open interval `[start, end)`. With `bounds`, the inputs are read in that notation and normalized: an inclusive end (`]`) or an exclusive start (`(`) moves forward by one day on a `PlainDate` and one nanosecond otherwise. `interval(d, d, { bounds: '[]' })` is the one-day interval `[d, d + 1 day)`. Throws `RangeError` when `start` is after `end` once normalized; mixed kinds throw `TypeError`." }, { "subpath": "./interval", "name": "Interval", "kind": "type", "signature": "export type Interval = Readonly<{ start: T; end: T; }>;", "jsdocSummary": "A half-open range `[start, end)`: `start` is included, `end` is **excluded**. `start` is never after `end`; `start == end` is the empty interval." }, { "subpath": "./interval", "name": "intervalEquals", "kind": "function", "signature": "export declare function intervalEquals(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Same start and same end (zoned values compare by instant, so the zones may differ)." }, { "subpath": "./interval", "name": "intervalLength", "kind": "function", "signature": "export declare function intervalLength(i: Interval, unit: UnitFor>, options?: DiffOptions): number;", "jsdocSummary": "The length of the interval in `unit`: `diff(start, end, unit, options)`. Whole units truncated toward zero unless `fractional: true`." }, { "subpath": "./interval", "name": "IntervalOptions", "kind": "type", "signature": "export type IntervalOptions = Readonly<{ /** Bound notation of the inputs: `[` / `]` inclusive, `(` / `)` exclusive. Default `[)`. */ bounds?: Bounds; }>;", "jsdocSummary": "" }, { "subpath": "./interval", "name": "isEmptyInterval", "kind": "function", "signature": "export declare function isEmptyInterval(i: Interval): boolean;", "jsdocSummary": "Does the interval cover nothing (`start == end`)?" }, { "subpath": "./interval", "name": "IterateOptions", "kind": "type", "signature": "export type IterateOptions = Readonly<{ /** Throw a `RangeError` rather than produce more than this many values. Default 10 000. */ maxItems?: number; }>;", "jsdocSummary": "" }, { "subpath": "./interval", "name": "mergeIntervals", "kind": "function", "signature": "export declare function mergeIntervals(list: readonly Interval[]): readonly Interval[];", "jsdocSummary": "Sort and merge: overlapping and touching intervals join; empty intervals are dropped (they cover nothing). The result is sorted, disjoint and never touching." }, { "subpath": "./interval", "name": "overlaps", "kind": "function", "signature": "export declare function overlaps(a: Interval, b: Interval>): boolean;", "jsdocSummary": "Do the intervals share at least one point? Touching intervals and empty intervals never overlap." }, { "subpath": "./interval", "name": "range", "kind": "function", "signature": "export declare function range(start: T, end: NoInfer, step: AmountFor>, options?: IterateOptions): IterableIterator;", "jsdocSummary": "`each(interval(start, end), step, options)`: values in `[start, end)` anchored at `start`." }, { "subpath": "./interval", "name": "splitByUnit", "kind": "function", "signature": "export declare function splitByUnit(i: Interval, unit: UnitFor>, options?: SplitOptions): IterableIterator>;", "jsdocSummary": "The interval cut at every `unit` boundary (`startOf` / `nextBoundary`; weeks per `options.week`, ISO by default). The first and last pieces may be partial; together the pieces rebuild the input exactly. An empty interval yields nothing." }, { "subpath": "./interval", "name": "SplitOptions", "kind": "type", "signature": "export type SplitOptions = Readonly<{ week?: WeekRules; maxItems?: number; }>;", "jsdocSummary": "" }, { "subpath": "./interval", "name": "subtract", "kind": "function", "signature": "export declare function subtract(a: Interval, b: Interval>): readonly Interval[];", "jsdocSummary": "The parts of `a` not covered by `b`: zero, one or two pieces, in order." }, { "subpath": "./interval", "name": "symmetricDifference", "kind": "function", "signature": "export declare function symmetricDifference(a: Interval, b: Interval>): readonly Interval[];", "jsdocSummary": "The points in exactly one of the two intervals, as sorted disjoint pieces." }, { "subpath": "./interval", "name": "toISOInterval", "kind": "function", "signature": "export declare function toISOInterval(i: Interval): string;", "jsdocSummary": "ISO 8601 interval text: `start/end` (the end is exclusive)." }, { "subpath": "./interval", "name": "union", "kind": "function", "signature": "export declare function union(a: Interval, ...rest: readonly Interval>[]): readonly Interval[];", "jsdocSummary": "Everything covered by any of the intervals, as sorted disjoint pieces. Overlapping and touching intervals merge; a gap is never filled in." }, { "subpath": "./math", "name": "add", "kind": "function", "signature": "export declare function add(value: T, amount: Amount | Duration, options?: ArithmeticOptions): T; ; export declare function add(value: T, amount: AmountFor> | Duration, options?: ArithmeticOptions): T;", "jsdocSummary": "`value + amount`. Calendar amounts are rejected on an `Instant` (project it into a zone first)." }, { "subpath": "./math", "name": "ArithmeticOptions", "kind": "type", "signature": "export type ArithmeticOptions = Readonly<{ overflow?: Overflow; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "CalendarUntilOptions", "kind": "type", "signature": "export type CalendarUntilOptions = Readonly<{ largestUnit: Exclude; smallestUnit?: Exclude; roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "ceil", "kind": "function", "signature": "export declare function ceil(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function ceil(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round up to the unit; a value already on the boundary is returned unchanged." }, { "subpath": "./math", "name": "diff", "kind": "function", "signature": "export declare function diff(from: T, to: NoInfer, unit: CalendarUnit, options?: DiffOptions): number; ; export declare function diff(from: T, to: NoInfer, unit: UnitFor>, options?: DiffOptions): number;", "jsdocSummary": "`to − from` as a number of units. Positive when `to` is later." }, { "subpath": "./math", "name": "diffElapsed", "kind": "function", "signature": "export declare function diffElapsed(from: Timeline | Date, to: Timeline | Date, unit: TimeUnit | 'day' | 'week', options?: DiffOptions): number;", "jsdocSummary": "Elapsed time between two instants. Here a `day` is exactly 24 hours and a `week` 168 hours — use `diff` on zoned values for calendar days." }, { "subpath": "./math", "name": "DiffOptions", "kind": "type", "signature": "export type DiffOptions = Readonly<{ /** Return the exact fractional total instead of truncating toward zero. */ fractional?: boolean; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "elapsedNanoseconds", "kind": "function", "signature": "export declare function elapsedNanoseconds(from: Timeline | Date, to: Timeline | Date): bigint;", "jsdocSummary": "Exact nanoseconds from `from` to `to`, ignoring calendars and zones." }, { "subpath": "./math", "name": "endOf", "kind": "function", "signature": "export declare function endOf(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function endOf(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The last representable moment of the unit: the next boundary minus one day for a `PlainDate`, minus one nanosecond otherwise. Prefer `[startOf, nextBoundary)` for range queries; `endOf` exists for display and inclusive APIs." }, { "subpath": "./math", "name": "floor", "kind": "function", "signature": "export declare function floor(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function floor(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round down to the unit (or to a multiple of it via `increment`). Same as `startOf` for calendar units." }, { "subpath": "./math", "name": "Instant", "kind": "type", "signature": "export type Instant = Temporal.Instant;", "jsdocSummary": "An exact moment on the timeline, zone-less: timestamps, logs, `timestamptz`." }, { "subpath": "./math", "name": "nextBoundary", "kind": "function", "signature": "export declare function nextBoundary(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function nextBoundary(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The start of the unit after the one containing `value` — the exclusive end of `startOf(value, unit)`. Always after `value`." }, { "subpath": "./math", "name": "parts", "kind": "function", "signature": "export declare function parts(value: PlainDate): DateParts; ; export declare function parts(value: Wall): WallParts; ; export declare function parts(value: Civil): DateParts | WallParts;", "jsdocSummary": "The calendar (and, for wall-clock values, time) fields as a plain object." }, { "subpath": "./math", "name": "PartsFor", "kind": "type", "signature": "export type PartsFor = T extends PlainDate ? DateParts : WallParts;", "jsdocSummary": "" }, { "subpath": "./math", "name": "round", "kind": "function", "signature": "export declare function round(value: T, unit: CalendarUnit, options?: RoundOptions): T; ; export declare function round(value: T, unit: UnitFor>, options?: RoundOptions): T;", "jsdocSummary": "Round to the nearest unit boundary; ties go to the later boundary unless `tie: 'earlier'`." }, { "subpath": "./math", "name": "RoundOptions", "kind": "type", "signature": "export type RoundOptions = Readonly<{ /** Round to a multiple of the unit (e.g. 15 minutes). Calendar units support only 1. */ increment?: number; week?: WeekRules; /** For `round`: which side wins an exact tie. Default `later`. */ tie?: 'earlier' | 'later'; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "set", "kind": "function", "signature": "export declare function set(value: T, patch: Partial>>, options?: SetOptions): T;", "jsdocSummary": "A copy with the given fields replaced. Out-of-range fields clamp unless `overflow: 'reject'`." }, { "subpath": "./math", "name": "SetOptions", "kind": "type", "signature": "export type SetOptions = Readonly<{ overflow?: Overflow; disambiguation?: Disambiguation; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "startOf", "kind": "function", "signature": "export declare function startOf(value: T, unit: CalendarUnit, options?: WeekOptions): T; ; export declare function startOf(value: T, unit: UnitFor>, options?: WeekOptions): T;", "jsdocSummary": "The first moment of the unit containing `value` (week per `options.week`, ISO by default)." }, { "subpath": "./math", "name": "sub", "kind": "function", "signature": "export declare function sub(value: T, amount: Amount | Duration, options?: ArithmeticOptions): T; ; export declare function sub(value: T, amount: AmountFor> | Duration, options?: ArithmeticOptions): T;", "jsdocSummary": "`value − amount`. Not always the inverse of `add` (Jan 31 + 1 month − 1 month = Feb 28 − 1 month = Jan 28)." }, { "subpath": "./math", "name": "until", "kind": "function", "signature": "export declare function until(from: T, to: NoInfer, options: CalendarUntilOptions): Duration; ; export declare function until(from: T, to: NoInfer, options: UntilOptions>): Duration;", "jsdocSummary": "`to − from` as a balanced `Duration` (e.g. 1 month 3 days 4 hours)." }, { "subpath": "./math", "name": "UntilOptions", "kind": "type", "signature": "export type UntilOptions = Readonly<{ largestUnit: Exclude, 'quarter'>; smallestUnit?: Exclude, 'quarter'>; roundingMode?: RoundingMode; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "WeekOptions", "kind": "type", "signature": "export type WeekOptions = Readonly<{ week?: WeekRules; }>;", "jsdocSummary": "" }, { "subpath": "./math", "name": "ZonedDateTime", "kind": "type", "signature": "export type ZonedDateTime = Temporal.ZonedDateTime;", "jsdocSummary": "An exact moment projected into an IANA time zone — the everyday scheduling type." }, { "subpath": "./orpc", "name": "registerTemporalTypes", "kind": "function", "signature": "export declare function registerTemporalTypes(superjson: Pick): void;", "jsdocSummary": "Teach a SuperJSON instance (or the `SuperJSON` default export) the Temporal types. Registering twice replaces the earlier entry, so module reloads are safe." }, { "subpath": "./orpc", "name": "TEMPORAL_RPC_TYPES", "kind": "variable", "signature": "export declare const TEMPORAL_RPC_TYPES: Readonly<{ instant: 100; zonedDateTime: 101; plainDate: 102; plainDateTime: 103; duration: 104; }>;", "jsdocSummary": "The oRPC custom type ids these codecs use. oRPC's built-in types use 0–8; keep any custom serializers of your own away from 100–104." }, { "subpath": "./orpc", "name": "temporalJsonSerializers", "kind": "variable", "signature": "export declare const temporalJsonSerializers: readonly StandardRPCCustomJsonSerializer[];", "jsdocSummary": "oRPC `customJsonSerializers` for every Temporal type. Pass the same list to `RPCHandler` and `RPCLink`." }, { "subpath": "./parse", "name": "parseDate", "kind": "function", "signature": "export declare function parseDate(text: string, pattern: string, options?: ParseOptions): PlainDate;", "jsdocSummary": "A calendar date read from `text` laid out by `pattern`, e.g. `parseDate('Mar 5, 2026', 'MMM d, yyyy')`. The pattern needs a year and a month + day (or a day of year `D`). Time tokens are read, validated and dropped; offset tokens are refused (use `parseZoned`)." }, { "subpath": "./parse", "name": "parseDateTime", "kind": "function", "signature": "export declare function parseDateTime(text: string, pattern: string, options?: ParseOptions): PlainDateTime;", "jsdocSummary": "A wall-clock date and time read from `text` laid out by `pattern`, e.g. `parseDateTime('03/05/2026 9:30 PM', 'MM/dd/yyyy h:mm a')`. Missing time fields are zero; offset tokens are refused (use `parseZoned`)." }, { "subpath": "./parse", "name": "ParseOptions", "kind": "type", "signature": "export type ParseOptions = Readonly<{ locale?: string; }>;", "jsdocSummary": "Locale (BCP 47, default `'en-US'`) whose month, weekday and AM/PM words are accepted." }, { "subpath": "./parse", "name": "parseZoned", "kind": "function", "signature": "export declare function parseZoned(text: string, pattern: string, timeZone: string, options?: ParseOptions & ZonedOptions): ZonedDateTime;", "jsdocSummary": "A moment in `timeZone` read from `text` laid out by `pattern`. With an offset token (`X`, `x`…) the text names an exact instant, which is shown in `timeZone`. Without one, the text is a wall-clock time in `timeZone`; skipped or repeated times resolve with `disambiguation` (default `'compatible'`)." }, { "subpath": "./parse", "name": "tryParseDate", "kind": "function", "signature": "export declare function tryParseDate(text: string, pattern: string, options?: ParseOptions): PlainDate | undefined;", "jsdocSummary": "`parseDate` that returns `undefined` when the text does not match. A bad pattern still throws." }, { "subpath": "./parse", "name": "tryParseDateTime", "kind": "function", "signature": "export declare function tryParseDateTime(text: string, pattern: string, options?: ParseOptions): PlainDateTime | undefined;", "jsdocSummary": "`parseDateTime` that returns `undefined` when the text does not match. A bad pattern still throws." }, { "subpath": "./parse", "name": "tryParseZoned", "kind": "function", "signature": "export declare function tryParseZoned(text: string, pattern: string, timeZone: string, options?: ParseOptions & ZonedOptions): ZonedDateTime | undefined;", "jsdocSummary": "`parseZoned` that returns `undefined` when the text does not match or names a wall time that `disambiguation: 'reject'` refuses. A bad pattern or time zone still throws." }, { "subpath": "./react", "name": "NowOptions", "kind": "type", "signature": "export type NowOptions = Readonly<{ /** Milliseconds between ticks. `0` or `Infinity` means never tick. */ every?: number; /** Clock to read. Default: the system clock. */ clock?: Clock; }>;", "jsdocSummary": "How often a hook re-reads the clock." }, { "subpath": "./react", "name": "useNow", "kind": "function", "signature": "export declare function useNow(options?: NowOptions): Instant;", "jsdocSummary": "The current `Instant`, re-read every `every` ms (default 1000)." }, { "subpath": "./react", "name": "useRelativeTime", "kind": "function", "signature": "export declare function useRelativeTime(target: Timeline | Date, options?: RelativeOptions & NowOptions): string;", "jsdocSummary": "`relative(target, now)` text such as \"in 3 minutes\", refreshed every `every` ms (default 60 000)." }, { "subpath": "./react", "name": "useToday", "kind": "function", "signature": "export declare function useToday(options?: NowOptions & Readonly<{ timeZone?: string; }>): PlainDate;", "jsdocSummary": "Today's date in `timeZone` (runtime zone by default), re-read every `every` ms (default 60 000). It only re-renders when the date changes." }, { "subpath": "./relative", "name": "relative", "kind": "function", "signature": "export declare function relative(target: Timeline | Date, reference: Timeline | Date, options?: RelativeOptions): string;", "jsdocSummary": "Locale text for `target` seen from `reference`: \"in 3 days\", \"3 days ago\", or \"tomorrow\" with `numeric: 'auto'`." }, { "subpath": "./relative", "name": "RelativeOptions", "kind": "type", "signature": "export type RelativeOptions = Readonly<{ locale?: string; /** Force one unit, or `'auto'` (default) to pick by distance. */ unit?: RelativeUnit | 'auto'; /** `'auto'` allows words like \"yesterday\" and \"tomorrow\". Default `'always'`. */ numeric?: 'always' | 'auto'; style?: 'long' | 'short' | 'narrow'; /** Zone for calendar-day comparison. Default: the target's zone if zoned, else the runtime zone. */ timeZone?: string; }>;", "jsdocSummary": "" }, { "subpath": "./relative", "name": "relativeToNow", "kind": "function", "signature": "export declare function relativeToNow(target: Timeline | Date, options?: RelativeOptions & ClockOptions): string;", "jsdocSummary": "`relative(target, now({ clock }))`. Pass a `MockClock` for deterministic output." }, { "subpath": "./relative", "name": "relativeUnit", "kind": "function", "signature": "export declare function relativeUnit(target: Timeline | Date, reference: Timeline | Date, options?: RelativeOptions): RelativeValue;", "jsdocSummary": "The unit and signed whole value `relative` would print. Auto selection: < 60 s → second, < 60 min → minute, < 24 h → hour (exact time), then by calendar days in the zone: < 7 days → day, < 1 month → week, < 12 months → month, else year." }, { "subpath": "./relative", "name": "RelativeUnit", "kind": "type", "signature": "export type RelativeUnit = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';", "jsdocSummary": "" }, { "subpath": "./relative", "name": "RelativeValue", "kind": "type", "signature": "export type RelativeValue = Readonly<{ unit: RelativeUnit; value: number; }>;", "jsdocSummary": "" }, { "subpath": "./tanstack", "name": "durationSerializationAdapter", "kind": "variable", "signature": "export declare const durationSerializationAdapter: import(\"@tanstack/react-router\").SerializationAdapter;", "jsdocSummary": "" }, { "subpath": "./tanstack", "name": "instantSerializationAdapter", "kind": "variable", "signature": "export declare const instantSerializationAdapter: import(\"@tanstack/react-router\").SerializationAdapter;", "jsdocSummary": "" }, { "subpath": "./tanstack", "name": "plainDateSerializationAdapter", "kind": "variable", "signature": "export declare const plainDateSerializationAdapter: import(\"@tanstack/react-router\").SerializationAdapter;", "jsdocSummary": "" }, { "subpath": "./tanstack", "name": "plainDateTimeSerializationAdapter", "kind": "variable", "signature": "export declare const plainDateTimeSerializationAdapter: import(\"@tanstack/react-router\").SerializationAdapter;", "jsdocSummary": "" }, { "subpath": "./tanstack", "name": "temporalSerializationAdapters", "kind": "variable", "signature": "export declare const temporalSerializationAdapters: readonly [import(\"@tanstack/react-router\").SerializationAdapter, import(\"@tanstack/react-router\").SerializationAdapter, import(\"@tanstack/react-router\").SerializationAdapter, import(\"@tanstack/react-router\").SerializationAdapter, import(\"@tanstack/react-router\").SerializationAdapter];", "jsdocSummary": "All five adapters, for `createStart(() => ({ serializationAdapters }))`." }, { "subpath": "./tanstack", "name": "zonedDateTimeSerializationAdapter", "kind": "variable", "signature": "export declare const zonedDateTimeSerializationAdapter: import(\"@tanstack/react-router\").SerializationAdapter;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Amount", "kind": "type", "signature": "export type Amount = CalendarAmount & TimeAmount;", "jsdocSummary": "" }, { "subpath": "./types", "name": "AmountFor", "kind": "type", "signature": "export type AmountFor = Instant extends T ? TimeAmount : Amount;", "jsdocSummary": "The amounts a point type accepts: anything for civil values (a `PlainDate` balances time fields into whole days, as Temporal does), time only for an `Instant` or a union containing one." }, { "subpath": "./types", "name": "Bounds", "kind": "type", "signature": "export type Bounds = '[)' | '[]' | '()' | '(]';", "jsdocSummary": "Interval bounds notation: `[` / `]` inclusive, `(` / `)` exclusive." }, { "subpath": "./types", "name": "CalendarAmount", "kind": "type", "signature": "export type CalendarAmount = Readonly<{ years?: number; quarters?: number; months?: number; weeks?: number; days?: number; }>;", "jsdocSummary": "" }, { "subpath": "./types", "name": "CalendarUnit", "kind": "type", "signature": "export type CalendarUnit = 'year' | 'quarter' | 'month' | 'week' | 'day';", "jsdocSummary": "" }, { "subpath": "./types", "name": "Civil", "kind": "type", "signature": "export type Civil = PlainDate | PlainDateTime | ZonedDateTime;", "jsdocSummary": "Points that carry calendar fields (year, month, day)." }, { "subpath": "./types", "name": "DateParts", "kind": "type", "signature": "export type DateParts = Readonly<{ year: number; month: number; day: number; }>;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Disambiguation", "kind": "type", "signature": "export type Disambiguation = 'compatible' | 'earlier' | 'later' | 'reject';", "jsdocSummary": "What to do when a wall-clock time is skipped or repeated by a DST transition." }, { "subpath": "./types", "name": "Duration", "kind": "type", "signature": "export type Duration = Temporal.Duration;", "jsdocSummary": "A signed amount of time with separate calendar (years…days) and exact (hours…ns) fields." }, { "subpath": "./types", "name": "DurationUnit", "kind": "type", "signature": "export type DurationUnit = Exclude;", "jsdocSummary": "Units a `Duration` can carry (Temporal has no quarter field; quarters expand to 3 months)." }, { "subpath": "./types", "name": "Instant", "kind": "type", "signature": "export type Instant = Temporal.Instant;", "jsdocSummary": "An exact moment on the timeline, zone-less: timestamps, logs, `timestamptz`." }, { "subpath": "./types", "name": "isDuration", "kind": "function", "signature": "export declare function isDuration(value: unknown): value is Duration;", "jsdocSummary": "" }, { "subpath": "./types", "name": "isInstant", "kind": "function", "signature": "export declare function isInstant(value: unknown): value is Instant;", "jsdocSummary": "" }, { "subpath": "./types", "name": "ISO_WEEK", "kind": "variable", "signature": "export declare const ISO_WEEK: WeekRules;", "jsdocSummary": "ISO 8601 weeks: Monday start, week 1 contains January 4. The package default." }, { "subpath": "./types", "name": "isPlainDate", "kind": "function", "signature": "export declare function isPlainDate(value: unknown): value is PlainDate;", "jsdocSummary": "" }, { "subpath": "./types", "name": "isPlainDateTime", "kind": "function", "signature": "export declare function isPlainDateTime(value: unknown): value is PlainDateTime;", "jsdocSummary": "" }, { "subpath": "./types", "name": "isPoint", "kind": "function", "signature": "export declare function isPoint(value: unknown): value is Point;", "jsdocSummary": "" }, { "subpath": "./types", "name": "isZonedDateTime", "kind": "function", "signature": "export declare function isZonedDateTime(value: unknown): value is ZonedDateTime;", "jsdocSummary": "" }, { "subpath": "./types", "name": "kindOf", "kind": "function", "signature": "export declare function kindOf(value: Point): PointKind;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Ordering", "kind": "type", "signature": "export type Ordering = -1 | 0 | 1;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Overflow", "kind": "type", "signature": "export type Overflow = 'constrain' | 'reject';", "jsdocSummary": "What to do when a field is out of range: clamp (Jan 31 + 1 month = Feb 28) or throw." }, { "subpath": "./types", "name": "PlainDate", "kind": "type", "signature": "export type PlainDate = Temporal.PlainDate;", "jsdocSummary": "A calendar date with no time and no zone: a birthday, a due date, a holiday." }, { "subpath": "./types", "name": "PlainDateTime", "kind": "type", "signature": "export type PlainDateTime = Temporal.PlainDateTime;", "jsdocSummary": "A wall-clock date + time with no zone: \"the meeting is at 09:00 local\"." }, { "subpath": "./types", "name": "Point", "kind": "type", "signature": "export type Point = PlainDate | PlainDateTime | ZonedDateTime | Instant;", "jsdocSummary": "Any point-in-time value this package operates on." }, { "subpath": "./types", "name": "PointKind", "kind": "type", "signature": "export type PointKind = 'plainDate' | 'plainDateTime' | 'zonedDateTime' | 'instant';", "jsdocSummary": "" }, { "subpath": "./types", "name": "RoundingMode", "kind": "type", "signature": "export type RoundingMode = 'trunc' | 'floor' | 'ceil' | 'halfExpand';", "jsdocSummary": "" }, { "subpath": "./types", "name": "SUNDAY_WEEK", "kind": "variable", "signature": "export declare const SUNDAY_WEEK: WeekRules;", "jsdocSummary": "North-American convention: Sunday start, week 1 contains January 1." }, { "subpath": "./types", "name": "Temporal", "kind": "namespace", "signature": "export namespace Temporal { type CalendarLike = | PlainDate | PlainDateTime | PlainMonthDay | PlainYearMonth | ZonedDateTime | string type DurationLike = Duration | DurationLikeObject | string type InstantLike = Instant | ZonedDateTime | string type PlainDateLike = | PlainDate | ZonedDateTime | PlainDateTime | DateLikeObject | string type PlainDateTimeLike = | PlainDateTime | ZonedDateTime | PlainDate | DateTimeLikeObject | string type PlainMonthDayLike = PlainMonthDay | DateLikeObject | string type PlainTimeLike = | PlainTime | PlainDateTime | ZonedDateTime | TimeLikeObject | string type PlainYearMonthLike = PlainYearMonth | YearMonthLikeObject | string type TimeZoneLike = ZonedDateTime | string type ZonedDateTimeLike = ZonedDateTime | ZonedDateTimeLikeObject | string type PartialTemporalLike = { [P in Exclude]?: T[P] | undefined } interface DateLikeObject { year?: number | undefined era?: string | undefined eraYear?: number | undefined month?: number | undefined monthCode?: string | undefined day: number calendar?: string | undefined } interface DateTimeLikeObject extends DateLikeObject, TimeLikeObject {} interface DurationLikeObject { years?: number | undefined months?: number | undefined weeks?: number | undefined days?: number | undefined hours?: number | undefined minutes?: number | undefined seconds?: number | undefined milliseconds?: number | undefined microseconds?: number | undefined nanoseconds?: number | undefined } interface TimeLikeObject { hour?: number | undefined minute?: number | undefined second?: number | undefined millisecond?: number | undefined microsecond?: number | undefined nanosecond?: number | undefined } interface YearMonthLikeObject extends Omit {} interface ZonedDateTimeLikeObject extends DateTimeLikeObject { timeZone: TimeZoneLike offset?: string | undefined } type DateUnit = 'year' | 'month' | 'week' | 'day' type TimeUnit = | 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond' | 'nanosecond' type PluralizeUnit = | T | { year: 'years' month: 'months' week: 'weeks' day: 'days' hour: 'hours' minute: 'minutes' second: 'seconds' millisecond: 'milliseconds' microsecond: 'microseconds' nanosecond: 'nanoseconds' }[T] interface DisambiguationOptions { disambiguation?: 'compatible' | 'earlier' | 'later' | 'reject' | undefined } interface OverflowOptions { overflow?: 'constrain' | 'reject' | undefined } interface TransitionOptions { direction: 'next' | 'previous' } interface RoundingOptions { smallestUnit?: PluralizeUnit | undefined roundingIncrement?: number | undefined roundingMode?: | 'ceil' | 'floor' | 'expand' | 'trunc' | 'halfCeil' | 'halfFloor' | 'halfExpand' | 'halfTrunc' | 'halfEven' | undefined } interface RoundingOptionsWithLargestUnit extends RoundingOptions { largestUnit?: 'auto' | PluralizeUnit | undefined } interface ToStringRoundingOptions extends Pick, 'smallestUnit' | 'roundingMode'> {} interface ToStringRoundingOptionsWithFractionalSeconds< Units extends DateUnit | TimeUnit, > extends ToStringRoundingOptions { fractionalSecondDigits?: | 'auto' | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined } namespace Now { function timeZoneId(): string function instant(): Instant function plainDateTimeISO(timeZone?: TimeZoneLike): PlainDateTime function zonedDateTimeISO(timeZone?: TimeZoneLike): ZonedDateTime function plainDateISO(timeZone?: TimeZoneLike): PlainDate function plainTimeISO(timeZone?: TimeZoneLike): PlainTime } interface PlainDateToStringOptions { calendarName?: 'auto' | 'always' | 'never' | 'critical' | undefined } interface PlainDateToZonedDateTimeOptions { plainTime?: PlainTimeLike | undefined timeZone: TimeZoneLike } interface PlainDate { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean toPlainYearMonth(): PlainYearMonth toPlainMonthDay(): PlainMonthDay add(duration: DurationLike, options?: OverflowOptions): PlainDate subtract(duration: DurationLike, options?: OverflowOptions): PlainDate with( dateLike: PartialTemporalLike, options?: OverflowOptions, ): PlainDate withCalendar(calendarLike: CalendarLike): PlainDate until( other: PlainDateLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainDateLike, options?: RoundingOptionsWithLargestUnit, ): Duration equals(other: PlainDateLike): boolean toPlainDateTime(time?: PlainTimeLike): PlainDateTime toZonedDateTime(timeZone: TimeZoneLike): ZonedDateTime toZonedDateTime(item: PlainDateToZonedDateTimeOptions): ZonedDateTime toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.PlainDate' } interface PlainDateConstructor { new ( isoYear: number, isoMonth: number, isoDay: number, calendar?: string, ): PlainDate readonly prototype: PlainDate from(item: PlainDateLike, options?: OverflowOptions): PlainDate compare(one: PlainDateLike, two: PlainDateLike): number } var PlainDate: PlainDateConstructor interface PlainTimeToStringOptions extends ToStringRoundingOptionsWithFractionalSeconds< Exclude > {} interface PlainTime { readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number add(duration: DurationLike): PlainTime subtract(duration: DurationLike): PlainTime with( timeLike: PartialTemporalLike, options?: OverflowOptions, ): PlainTime until( other: PlainTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration equals(other: PlainTimeLike): boolean round(roundTo: PluralizeUnit): PlainTime round(roundTo: RoundingOptions): PlainTime toString(options?: PlainTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.PlainTime' } interface PlainTimeConstructor { new ( hour?: number, minute?: number, second?: number, millisecond?: number, microsecond?: number, nanosecond?: number, ): PlainTime readonly prototype: PlainTime from(item: PlainTimeLike, options?: OverflowOptions): PlainTime compare(one: PlainTimeLike, two: PlainTimeLike): number } var PlainTime: PlainTimeConstructor interface PlainDateTimeToStringOptions extends PlainDateToStringOptions, PlainTimeToStringOptions {} interface PlainDateTime { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean with( dateTimeLike: PartialTemporalLike, options?: OverflowOptions, ): PlainDateTime withPlainTime(plainTime?: PlainTimeLike): PlainDateTime withCalendar(calendar: CalendarLike): PlainDateTime add(duration: DurationLike, options?: OverflowOptions): PlainDateTime subtract(duration: DurationLike, options?: OverflowOptions): PlainDateTime until( other: PlainDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: PlainDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): PlainDateTime round(roundTo: RoundingOptions<'day' | TimeUnit>): PlainDateTime equals(other: PlainDateTimeLike): boolean toString(options?: PlainDateTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toZonedDateTime( timeZone: TimeZoneLike, options?: DisambiguationOptions, ): ZonedDateTime toPlainDate(): PlainDate toPlainTime(): PlainTime readonly [Symbol.toStringTag]: 'Temporal.PlainDateTime' } interface PlainDateTimeConstructor { new ( isoYear: number, isoMonth: number, isoDay: number, hour?: number, minute?: number, second?: number, millisecond?: number, microsecond?: number, nanosecond?: number, calendar?: string, ): PlainDateTime readonly prototype: PlainDateTime from(item: PlainDateTimeLike, options?: OverflowOptions): PlainDateTime compare(one: PlainDateTimeLike, two: PlainDateTimeLike): number } var PlainDateTime: PlainDateTimeConstructor interface ZonedDateTimeToStringOptions extends PlainDateTimeToStringOptions { offset?: 'auto' | 'never' | undefined timeZoneName?: 'auto' | 'never' | 'critical' | undefined } interface ZonedDateTimeFromOptions extends OverflowOptions, DisambiguationOptions { offset?: 'use' | 'ignore' | 'prefer' | 'reject' | undefined } interface ZonedDateTime { readonly calendarId: string readonly timeZoneId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly day: number readonly hour: number readonly minute: number readonly second: number readonly millisecond: number readonly microsecond: number readonly nanosecond: number readonly epochMilliseconds: number readonly epochNanoseconds: bigint readonly dayOfWeek: number readonly dayOfYear: number readonly weekOfYear: number | undefined readonly yearOfWeek: number | undefined readonly hoursInDay: number readonly daysInWeek: number readonly daysInMonth: number readonly daysInYear: number readonly monthsInYear: number readonly inLeapYear: boolean readonly offsetNanoseconds: number readonly offset: string with( zonedDateTimeLike: PartialTemporalLike, options?: ZonedDateTimeFromOptions, ): ZonedDateTime withPlainTime(plainTime?: PlainTimeLike): ZonedDateTime withTimeZone(timeZone: TimeZoneLike): ZonedDateTime withCalendar(calendar: CalendarLike): ZonedDateTime add(duration: DurationLike, options?: OverflowOptions): ZonedDateTime subtract(duration: DurationLike, options?: OverflowOptions): ZonedDateTime until( other: ZonedDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: ZonedDateTimeLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): ZonedDateTime round(roundTo: RoundingOptions<'day' | TimeUnit>): ZonedDateTime equals(other: ZonedDateTimeLike): boolean toString(options?: ZonedDateTimeToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never startOfDay(): ZonedDateTime getTimeZoneTransition(direction: 'next' | 'previous'): ZonedDateTime | null getTimeZoneTransition(direction: TransitionOptions): ZonedDateTime | null toInstant(): Instant toPlainDate(): PlainDate toPlainTime(): PlainTime toPlainDateTime(): PlainDateTime readonly [Symbol.toStringTag]: 'Temporal.ZonedDateTime' } interface ZonedDateTimeConstructor { new ( epochNanoseconds: bigint, timeZone: string, calendar?: string, ): ZonedDateTime readonly prototype: ZonedDateTime from( item: ZonedDateTimeLike, options?: ZonedDateTimeFromOptions, ): ZonedDateTime compare(one: ZonedDateTimeLike, two: ZonedDateTimeLike): number } var ZonedDateTime: ZonedDateTimeConstructor interface DurationRelativeToOptions { relativeTo?: ZonedDateTimeLike | PlainDateLike | undefined } interface DurationRoundingOptions extends DurationRelativeToOptions, RoundingOptionsWithLargestUnit {} interface DurationToStringOptions extends ToStringRoundingOptionsWithFractionalSeconds< Exclude > {} interface DurationTotalOptions extends DurationRelativeToOptions { unit: PluralizeUnit } // Use the host's Intl.DurationFormat options when the consumer includes a // lib that declares Intl.DurationFormat, without forcing this file to // reference es2025.intl for every consumer. type DurationFormatOptions = typeof Intl extends { DurationFormat: { new (locales?: unknown, options?: infer Options): unknown } } ? NonNullable : unknown interface Duration { readonly years: number readonly months: number readonly weeks: number readonly days: number readonly hours: number readonly minutes: number readonly seconds: number readonly milliseconds: number readonly microseconds: number readonly nanoseconds: number readonly sign: number readonly blank: boolean with(durationLike: PartialTemporalLike): Duration negated(): Duration abs(): Duration add(other: DurationLike): Duration subtract(other: DurationLike): Duration round(roundTo: PluralizeUnit<'day' | TimeUnit>): Duration round(roundTo: DurationRoundingOptions): Duration total(totalOf: PluralizeUnit<'day' | TimeUnit>): number total(totalOf: DurationTotalOptions): number toString(options?: DurationToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: DurationFormatOptions, ): string toJSON(): string valueOf(): never readonly [Symbol.toStringTag]: 'Temporal.Duration' } interface DurationConstructor { new ( years?: number, months?: number, weeks?: number, days?: number, hours?: number, minutes?: number, seconds?: number, milliseconds?: number, microseconds?: number, nanoseconds?: number, ): Duration readonly prototype: Duration from(item: DurationLike): Duration compare( one: DurationLike, two: DurationLike, options?: DurationRelativeToOptions, ): number } var Duration: DurationConstructor interface InstantToStringOptions extends PlainTimeToStringOptions { timeZone?: TimeZoneLike | undefined } interface Instant { readonly epochMilliseconds: number readonly epochNanoseconds: bigint add(duration: DurationLike): Instant subtract(duration: DurationLike): Instant until( other: InstantLike, options?: RoundingOptionsWithLargestUnit, ): Duration since( other: InstantLike, options?: RoundingOptionsWithLargestUnit, ): Duration round(roundTo: PluralizeUnit): Instant round(roundTo: RoundingOptions): Instant equals(other: InstantLike): boolean toString(options?: InstantToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toZonedDateTimeISO(timeZone: TimeZoneLike): ZonedDateTime readonly [Symbol.toStringTag]: 'Temporal.Instant' } interface InstantConstructor { new (epochNanoseconds: bigint): Instant readonly prototype: Instant from(item: InstantLike): Instant fromEpochMilliseconds(epochMilliseconds: number): Instant fromEpochNanoseconds(epochNanoseconds: bigint): Instant compare(one: InstantLike, two: InstantLike): number } var Instant: InstantConstructor interface PlainYearMonthToPlainDateOptions { day: number } interface PlainYearMonth { readonly calendarId: string readonly era: string | undefined readonly eraYear: number | undefined readonly year: number readonly month: number readonly monthCode: string readonly daysInYear: number readonly daysInMonth: number readonly monthsInYear: number readonly inLeapYear: boolean with( yearMonthLike: PartialTemporalLike, options?: OverflowOptions, ): PlainYearMonth add(duration: DurationLike, options?: OverflowOptions): PlainYearMonth subtract(duration: DurationLike, options?: OverflowOptions): PlainYearMonth until( other: PlainYearMonthLike, options?: RoundingOptionsWithLargestUnit<'year' | 'month'>, ): Duration since( other: PlainYearMonthLike, options?: RoundingOptionsWithLargestUnit<'year' | 'month'>, ): Duration equals(other: PlainYearMonthLike): boolean toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toPlainDate(item: PlainYearMonthToPlainDateOptions): PlainDate readonly [Symbol.toStringTag]: 'Temporal.PlainYearMonth' } interface PlainYearMonthConstructor { new ( isoYear: number, isoMonth: number, calendar?: string, referenceISODay?: number, ): PlainYearMonth readonly prototype: PlainYearMonth from(item: PlainYearMonthLike, options?: OverflowOptions): PlainYearMonth compare(one: PlainYearMonthLike, two: PlainYearMonthLike): number } var PlainYearMonth: PlainYearMonthConstructor interface PlainMonthDayToPlainDateOptions { era?: string | undefined eraYear?: number | undefined year?: number | undefined } interface PlainMonthDay { readonly calendarId: string readonly monthCode: string readonly day: number with( monthDayLike: PartialTemporalLike, options?: OverflowOptions, ): PlainMonthDay equals(other: PlainMonthDayLike): boolean toString(options?: PlainDateToStringOptions): string toLocaleString( locales?: globalThis.Intl.LocalesArgument, options?: globalThis.Intl.DateTimeFormatOptions, ): string toJSON(): string valueOf(): never toPlainDate(item: PlainMonthDayToPlainDateOptions): PlainDate readonly [Symbol.toStringTag]: 'Temporal.PlainMonthDay' } interface PlainMonthDayConstructor { new ( isoMonth: number, isoDay: number, calendar?: string, referenceISOYear?: number, ): PlainMonthDay readonly prototype: PlainMonthDay from(item: PlainMonthDayLike, options?: OverflowOptions): PlainMonthDay } var PlainMonthDay: PlainMonthDayConstructor }", "jsdocSummary": "" }, { "subpath": "./types", "name": "TimeAmount", "kind": "type", "signature": "export type TimeAmount = Readonly<{ hours?: number; minutes?: number; seconds?: number; milliseconds?: number; microseconds?: number; nanoseconds?: number; }>;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Timeline", "kind": "type", "signature": "export type Timeline = Instant | ZonedDateTime;", "jsdocSummary": "Points that identify an exact instant." }, { "subpath": "./types", "name": "TimeParts", "kind": "type", "signature": "export type TimeParts = Readonly<{ hour: number; minute: number; second: number; millisecond: number; microsecond: number; nanosecond: number; }>;", "jsdocSummary": "" }, { "subpath": "./types", "name": "TimeUnit", "kind": "type", "signature": "export type TimeUnit = 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond' | 'nanosecond';", "jsdocSummary": "" }, { "subpath": "./types", "name": "Unit", "kind": "type", "signature": "export type Unit = CalendarUnit | TimeUnit;", "jsdocSummary": "" }, { "subpath": "./types", "name": "UnitFor", "kind": "type", "signature": "export type UnitFor = Instant extends T ? PlainDate extends T ? never : TimeUnit : PlainDate extends T ? CalendarUnit : Unit;", "jsdocSummary": "The units a point type supports. For a union this is the intersection of its members' capabilities (`PlainDate | Instant` supports none — narrow first); for a generic `T extends Civil` use the calendar-unit overloads." }, { "subpath": "./types", "name": "Wall", "kind": "type", "signature": "export type Wall = PlainDateTime | ZonedDateTime;", "jsdocSummary": "Points that carry a wall-clock time of day." }, { "subpath": "./types", "name": "WallInput", "kind": "type", "signature": "export type WallInput = DateParts & Partial;", "jsdocSummary": "Date fields plus any subset of time fields (missing time fields are zero)." }, { "subpath": "./types", "name": "WallParts", "kind": "type", "signature": "export type WallParts = DateParts & TimeParts;", "jsdocSummary": "" }, { "subpath": "./types", "name": "Weekday", "kind": "type", "signature": "export type Weekday = 1 | 2 | 3 | 4 | 5 | 6 | 7;", "jsdocSummary": "ISO weekday: Monday = 1 … Sunday = 7 (same numbering as `Temporal.PlainDate#dayOfWeek`)." }, { "subpath": "./types", "name": "WeekRules", "kind": "type", "signature": "export type WeekRules = Readonly<{ startsOn: Weekday; minimalDays: 1 | 2 | 3 | 4 | 5 | 6 | 7; }>;", "jsdocSummary": "How weeks are counted. `startsOn` is the first day of the week; `minimalDays` is how many days of January must fall in week 1 (ISO: Monday, 4)." }, { "subpath": "./types", "name": "ZonedDateTime", "kind": "type", "signature": "export type ZonedDateTime = Temporal.ZonedDateTime;", "jsdocSummary": "An exact moment projected into an IANA time zone — the everyday scheduling type." }, { "subpath": "./zod", "name": "durationSchema", "kind": "function", "signature": "export declare function durationSchema(): z.ZodType;", "jsdocSummary": "A signed amount of time: an ISO 8601 duration such as `'P1DT2H'`, or a `Duration`. Output is a `Duration`." }, { "subpath": "./zod", "name": "instantSchema", "kind": "function", "signature": "export declare function instantSchema(): z.ZodType;", "jsdocSummary": "An exact moment: an ISO string with `Z` or an offset, an `Instant`, or a `Date`. Output is an `Instant`." }, { "subpath": "./zod", "name": "intervalSchema", "kind": "function", "signature": "export declare function intervalSchema(point: z.ZodType): z.ZodType, { start: unknown; end: unknown; }>;", "jsdocSummary": "A half-open interval `{ start, end }` whose ends are parsed by `point`. An `end` before `start` is an issue." }, { "subpath": "./zod", "name": "plainDateSchema", "kind": "function", "signature": "export declare function plainDateSchema(): z.ZodType;", "jsdocSummary": "A calendar date: `'YYYY-MM-DD'` or a `PlainDate`. Output is a `PlainDate`." }, { "subpath": "./zod", "name": "plainDateTimeSchema", "kind": "function", "signature": "export declare function plainDateTimeSchema(): z.ZodType;", "jsdocSummary": "A zone-less date and time: `'YYYY-MM-DDTHH:mm[:ss]'` or a `PlainDateTime`. Output is a `PlainDateTime`." }, { "subpath": "./zod", "name": "timeZoneSchema", "kind": "function", "signature": "export declare function timeZoneSchema(): z.ZodType;", "jsdocSummary": "An IANA time zone id. Output is the canonical id (for example `'europe/bucharest'` becomes `'Europe/Bucharest'`)." }, { "subpath": "./zod", "name": "zonedDateTimeSchema", "kind": "function", "signature": "export declare function zonedDateTimeSchema(options?: { timeZone?: string; }): z.ZodType;", "jsdocSummary": "An exact moment in a zone. Without `timeZone` a string must carry a `[Zone]` annotation; with `timeZone` the value is read in (or projected into) that zone." }, { "subpath": "./zone", "name": "atTime", "kind": "function", "signature": "export declare function atTime(date: PlainDate, time: Partial, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "A calendar date at a wall-clock time in a zone." }, { "subpath": "./zone", "name": "inZone", "kind": "function", "signature": "export declare function inZone(value: Timeline | Date, timeZone: string): ZonedDateTime;", "jsdocSummary": "The same instant, shown in another zone." }, { "subpath": "./zone", "name": "isValidTimeZone", "kind": "function", "signature": "export declare function isValidTimeZone(id: string): boolean;", "jsdocSummary": "Is this a time zone the runtime knows (IANA name or fixed offset)?" }, { "subpath": "./zone", "name": "offset", "kind": "function", "signature": "export declare function offset(value: ZonedDateTime): string;", "jsdocSummary": "The UTC offset as text, e.g. `+03:00`." }, { "subpath": "./zone", "name": "offsetMinutes", "kind": "function", "signature": "export declare function offsetMinutes(value: ZonedDateTime): number;", "jsdocSummary": "The UTC offset in minutes (east positive)." }, { "subpath": "./zone", "name": "reinterpretZone", "kind": "function", "signature": "export declare function reinterpretZone(value: ZonedDateTime, timeZone: string, options?: ZonedOptions): ZonedDateTime;", "jsdocSummary": "The same wall-clock fields, read as if they were in another zone (the instant changes)." }, { "subpath": "./zone", "name": "toUTC", "kind": "function", "signature": "export declare function toUTC(value: Timeline | Date): ZonedDateTime;", "jsdocSummary": "The same instant in UTC." } ], "groups": [], "errorCodes": [] }