API Reference

FirstWeekSpec

interface

A flexible specifier for a calendar week. Accepts a Temporal.PlainDate, a native Date, an ISO week number, a week-of-year, or a month/day pair.

Defined in package/src/resolve-first-week.ts:8

Prop	Type	Default
toLocaleString*	(() => string) \| ((locales?: string \| string[] \| undefined, options?: Intl.DateTimeFormatOptions \| undefined) => string) \| { (): string; (locales?: string \| string[] \| undefined, options?: Intl.DateTimeFormatOptions \| undefined): string; (locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions \| undefined): string; }	—
toString*	((options?: Temporal.ShowCalendarOption \| undefined) => string) \| (() => string) \| (() => string)	—
valueOf*	(() => never) \| (() => number) \| (() => Object)	—

Prop

Type

Default

toLocaleString*

(() => string) | ((locales?: string | string[] | undefined, options?: Intl.DateTimeFormatOptions | undefined) => string) | { (): string; (locales?: string | string[] | undefined, options?: Intl.DateTimeFormatOptions | undefined): string; (locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions | undefined): string; }

—

toString*

((options?: Temporal.ShowCalendarOption | undefined) => string) | (() => string) | (() => string)

—

valueOf*

(() => never) | (() => number) | (() => Object)

—

Members

PlainDateDate{ isoWeek: number; isoYear: number; }{ week: number; year: number; }{ month: number; year: number; day?: number; }