077861c7dc
Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to package.json. Generate initial API reference pages. Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.
11 KiB
temporal-hijri / HijriCalendar
Class: HijriCalendar
Defined in: src/calendars/HijriCalendar.ts:57
Base class implementing the TC39 Temporal Calendar Protocol for Hijri calendars.
Coordinate bridging: Temporal.PlainDate operates in the ISO (Gregorian) calendar. Every calendar method receives a PlainDate with ISO year/month/day, and must return results in the Hijri calendar's coordinate system. The bridge is toHijri() and fromHijri(), which delegate to the injected CalendarEngine.
Arithmetic strategy for dateAdd():
- Year and month deltas are applied in Hijri space (correct handling of variable month lengths).
- Day and week deltas are applied in ISO space after the Hijri addition, so that "add 30 days" always means exactly 30 days.
Extended by
Constructors
Constructor
new HijriCalendar(
engine):HijriCalendar
Defined in: src/calendars/HijriCalendar.ts:61
Parameters
engine
Returns
HijriCalendar
Properties
id
readonlyid:string
Defined in: src/calendars/HijriCalendar.ts:59
Methods
dateAdd()
dateAdd(
date,duration,_options?):PlainDate
Defined in: src/calendars/HijriCalendar.ts:346
Add a duration to a Hijri date.
Year and month additions are handled in Hijri space to preserve calendar semantics (e.g., adding one month to 1 Ramadan yields 1 Shawwal, not a fixed 30-day offset). Day and week additions are then applied in ISO space so that they always represent exact day counts.
Month normalization uses O(1) modular arithmetic instead of iterative loops. When the day-of-month exceeds the target month's length after a Hijri-space adjustment, it is clamped to the last valid day of that month.
Parameters
date
PlainDate
duration
Duration
_options?
overflow?
"constrain" | "reject"
Returns
PlainDate
dateFromFields()
dateFromFields(
fields,options?):PlainDate
Defined in: src/calendars/HijriCalendar.ts:279
Parameters
fields
day
number
month
number
year
number
options?
overflow?
"constrain" | "reject"
Returns
PlainDate
dateUntil()
dateUntil(
one,two,options?):Duration
Defined in: src/calendars/HijriCalendar.ts:384
Compute the difference between two Hijri dates.
For simplicity and correctness across variable-length Hijri months, this delegates to the underlying ISO PlainDate difference when the largest unit is days or weeks. Year/month differences require a Hijri-space calculation.
Parameters
one
PlainDate
two
PlainDate
options?
largestUnit?
DateUnit
Returns
Duration
day()
day(
date):number
Defined in: src/calendars/HijriCalendar.ts:169
Returns the day of the Hijri month (1-29 or 1-30).
Parameters
date
PlainDate
A Temporal.PlainDate with ISO (Gregorian) coordinates.
Returns
number
Day of month within the Hijri calendar.
dayOfWeek()
dayOfWeek(
date):number
Defined in: src/calendars/HijriCalendar.ts:234
ISO weekday: 1 = Monday, 7 = Sunday. PlainDate.dayOfWeek on an ISO-calendar date already gives ISO weekday, so no conversion is needed.
Parameters
date
PlainDate
Returns
number
dayOfYear()
dayOfYear(
date):number
Defined in: src/calendars/HijriCalendar.ts:242
Day within the Hijri year. Accumulates full months before the current one, then adds the day-of-month offset.
Parameters
date
PlainDate
Returns
number
daysInMonth()
daysInMonth(
date):number
Defined in: src/calendars/HijriCalendar.ts:184
Returns the number of days in the Hijri month containing the given date.
Hijri months alternate between 29 and 30 days, but the exact pattern differs by calendar system (UAQ uses fixed tables; FCNA uses calculation).
Parameters
date
PlainDate
A Temporal.PlainDate with ISO (Gregorian) coordinates.
Returns
number
29 or 30.
daysInWeek()
daysInWeek(
_date):number
Defined in: src/calendars/HijriCalendar.ts:263
Returns the number of days in a week.
Always 7. Required by the Temporal Calendar Protocol.
Parameters
_date
PlainDate
Returns
number
Always 7.
daysInYear()
daysInYear(
date):number
Defined in: src/calendars/HijriCalendar.ts:193
Sum all 12 month lengths for the Hijri year. Standard lunar years are 354 days; leap years (with an added day in Dhul-Hijja) are 355 days.
Parameters
date
PlainDate
Returns
number
fields()
fields(
fields):string[]
Defined in: src/calendars/HijriCalendar.ts:273
Return the list of fields that the calendar adds to a Temporal object. Non-era calendars return the input array unchanged.
Parameters
fields
string[]
Returns
string[]
inLeapYear()
inLeapYear(
date):boolean
Defined in: src/calendars/HijriCalendar.ts:223
Returns whether the Hijri year is a leap year (355 days).
Standard Hijri years have 354 days. A leap year adds one day to Dhul-Hijja (month 12), making it 355 days total.
Parameters
date
PlainDate
A Temporal.PlainDate with ISO (Gregorian) coordinates.
Returns
boolean
true if the year has 355 days.
mergeFields()
mergeFields(
fields,additionalFields):Record<string,unknown>
Defined in: src/calendars/HijriCalendar.ts:414
Parameters
fields
Record<string, unknown>
additionalFields
Record<string, unknown>
Returns
Record<string, unknown>
month()
month(
date):number
Defined in: src/calendars/HijriCalendar.ts:149
Returns the Hijri month (1-12) for the given ISO date.
Parameters
date
PlainDate
A Temporal.PlainDate with ISO (Gregorian) coordinates.
Returns
number
Month number 1 (Muharram) through 12 (Dhul-Hijja).
monthCode()
monthCode(
date):string
Defined in: src/calendars/HijriCalendar.ts:158
Month code per the Temporal proposal: "M01".."M12". Hijri months are always 1-12 (no leap/intercalary month), so the code is simply the zero-padded month number.
Parameters
date
PlainDate
Returns
string
monthDayFromFields()
monthDayFromFields(
fields,options?):PlainMonthDay
Defined in: src/calendars/HijriCalendar.ts:317
ISO-anchored PlainMonthDay per the Temporal Calendar Protocol. Reference year 1444 is intentional: it is a recent, well-covered UAQ year used to anchor the ISO coordinates when no year is supplied.
Parameters
fields
day
number
month
number
year?
number
options?
overflow?
"constrain" | "reject"
Returns
PlainMonthDay
monthsInYear()
monthsInYear(
_date):number
Defined in: src/calendars/HijriCalendar.ts:210
Returns the number of months in the Hijri year.
Always 12. Unlike the Hebrew calendar, the Hijri lunar calendar has no intercalary (leap) month — only a possible extra day in Dhul-Hijja.
Parameters
_date
PlainDate
Returns
number
Always 12.
toString()
toString():
string
Defined in: src/calendars/HijriCalendar.ts:66
Returns
string
weekOfYear()
weekOfYear(
date):number
Defined in: src/calendars/HijriCalendar.ts:252
Hijri week number counted from day 1 of Muharram (day 1-7 = week 1). No ISO week alignment.
Parameters
date
PlainDate
Returns
number
year()
year(
date):number
Defined in: src/calendars/HijriCalendar.ts:139
Returns the Hijri year for the given ISO date.
Parameters
date
PlainDate
A Temporal.PlainDate with ISO (Gregorian) coordinates.
Returns
number
The Hijri year, e.g. 1444.
yearMonthFromFields()
yearMonthFromFields(
fields,options?):PlainYearMonth
Defined in: src/calendars/HijriCalendar.ts:294
ISO-anchored PlainYearMonth per the Temporal Calendar Protocol. The resulting PlainYearMonth stores ISO coordinates internally, representing the Hijri month that starts on that ISO year/month.
Parameters
fields
month
number
year
number
options?
overflow?
"constrain" | "reject"
Returns
PlainYearMonth