Skip to main content
class Temporal.Calendar
implements CalendarProtocol
Unstable

A Temporal.Calendar is a representation of a calendar system. It includes information about how many days are in each year, how many months are in each year, how many days are in each month, and how to do arithmetic in that calendar system.

See https://tc39.es/proposal-temporal/docs/calendar.html for more details.

Constructors

new
Calendar(calendarIdentifier: string)

Properties

readonly
id: string
readonly
[Symbol.toStringTag]: "Temporal.Calendar"

Methods

dateAdd(
date: Temporal.PlainDate | PlainDateLike | string,
duration: Temporal.Duration | DurationLike | string,
options?: ArithmeticOptions,
): Temporal.PlainDate
dateFromFields(fields: YearOrEraAndEraYear & MonthOrMonthCode & { day: number; }, options?: AssignmentOptions): Temporal.PlainDate
dateUntil(
one: Temporal.PlainDate | PlainDateLike | string,
two: Temporal.PlainDate | PlainDateLike | string,
options?: DifferenceOptions<
| "year"
| "month"
| "week"
| "day"
>,
): Temporal.Duration
day(date:
| PlainDateLike
| string
): number
dayOfWeek(date:
| PlainDateLike
| string
): number
dayOfYear(date:
| PlainDateLike
| string
): number
daysInWeek(date:
| PlainDateLike
| string
): number
daysInYear(date:
| PlainDateLike
| string
): number
era(date:
| PlainDateLike
| string
): string | undefined
eraYear(date:
| PlainDateLike
| string
): number | undefined
fields(fields: Iterable<string>): string[]
inLeapYear(date:
| PlainDateLike
| string
): boolean
mergeFields(fields: Record<string, unknown>, additionalFields: Record<string, unknown>): Record<string, unknown>
monthDayFromFields(fields: MonthCodeOrMonthAndYear & { day: number; }, options?: AssignmentOptions): Temporal.PlainMonthDay
toJSON(): string
toString(): string
weekOfYear(date:
| PlainDateLike
| string
): number
year(date:
| PlainDateLike
| string
): number
yearMonthFromFields(fields: YearOrEraAndEraYear & MonthOrMonthCode, options?: AssignmentOptions): Temporal.PlainYearMonth
yearOfWeek(date:
| PlainDateLike
| string
): number

Static Methods

from(item: CalendarLike): Temporal.Calendar | CalendarProtocol

Constructors

new
Calendar(calendarIdentifier: string)

Properties

readonly
id: string
readonly
[Symbol.toStringTag]: "Temporal.Calendar"

Methods

dateAdd(
date: Temporal.PlainDate | PlainDateLike | string,
duration: Temporal.Duration | DurationLike | string,
options?: ArithmeticOptions,
): Temporal.PlainDate
dateFromFields(fields: YearOrEraAndEraYear & MonthOrMonthCode & { day: number; }, options?: AssignmentOptions): Temporal.PlainDate
dateUntil(
one: Temporal.PlainDate | PlainDateLike | string,
two: Temporal.PlainDate | PlainDateLike | string,
options?: DifferenceOptions<
| "year"
| "month"
| "week"
| "day"
>,
): Temporal.Duration
day(date:
| PlainDateLike
| string
): number
dayOfWeek(date:
| PlainDateLike
| string
): number
dayOfYear(date:
| PlainDateLike
| string
): number
daysInWeek(date:
| PlainDateLike
| string
): number
daysInYear(date:
| PlainDateLike
| string
): number
era(date:
| PlainDateLike
| string
): string | undefined
eraYear(date:
| PlainDateLike
| string
): number | undefined
fields(fields: Iterable<string>): string[]
inLeapYear(date:
| PlainDateLike
| string
): boolean
mergeFields(fields: Record<string, unknown>, additionalFields: Record<string, unknown>): Record<string, unknown>
monthDayFromFields(fields: MonthCodeOrMonthAndYear & { day: number; }, options?: AssignmentOptions): Temporal.PlainMonthDay
toJSON(): string
toString(): string
weekOfYear(date:
| PlainDateLike
| string
): number
year(date:
| PlainDateLike
| string
): number
yearMonthFromFields(fields: YearOrEraAndEraYear & MonthOrMonthCode, options?: AssignmentOptions): Temporal.PlainYearMonth
yearOfWeek(date:
| PlainDateLike
| string
): number

Static Methods

from(item: CalendarLike): Temporal.Calendar | CalendarProtocol