docs: refresh TypeDoc API output (T-E8-03 QA-A verify)

This commit is contained in:
Aric Camarata 2026-05-30 17:48:46 -04:00
parent 235ffb8851
commit 27b89b03a8
20 changed files with 34 additions and 34 deletions

View file

@ -8,7 +8,7 @@
> **daysInHijriMonth**(`hy`, `hm`, `options?`): `number`
Defined in: [index.ts:96](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/index.ts#L96)
Defined in: [index.ts:96](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/index.ts#L96)
Return the number of days in a given Hijri month.

View file

@ -8,7 +8,7 @@
> **getCalendar**(`name`): [`CalendarEngine`](../interfaces/CalendarEngine.md)
Defined in: [registry.ts:25](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/registry.ts#L25)
Defined in: [registry.ts:25](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/registry.ts#L25)
Retrieve a registered calendar engine by name.

View file

@ -8,7 +8,7 @@
> **isValidHijriDate**(`hy`, `hm`, `hd`, `options?`): `boolean`
Defined in: [index.ts:78](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/index.ts#L78)
Defined in: [index.ts:78](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/index.ts#L78)
Check whether a Hijri date is valid for the given calendar engine.

View file

@ -8,7 +8,7 @@
> **listCalendars**(): `string`[]
Defined in: [registry.ts:41](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/registry.ts#L41)
Defined in: [registry.ts:41](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/registry.ts#L41)
List the names of all registered calendar engines.

View file

@ -8,7 +8,7 @@
> **registerCalendar**(`name`, `engine`): `void`
Defined in: [registry.ts:14](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/registry.ts#L14)
Defined in: [registry.ts:14](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/registry.ts#L14)
Register a calendar engine under the given name.

View file

@ -8,7 +8,7 @@
> **toGregorian**(`hy`, `hm`, `hd`, `options?`): `Date` \| `null`
Defined in: [index.ts:60](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/index.ts#L60)
Defined in: [index.ts:60](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/index.ts#L60)
Convert a Hijri date to a Gregorian date.

View file

@ -8,7 +8,7 @@
> **toHijri**(`date`, `options?`): [`HijriDate`](../interfaces/HijriDate.md) \| `null`
Defined in: [index.ts:42](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/index.ts#L42)
Defined in: [index.ts:42](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/index.ts#L42)
Convert a Gregorian date to a Hijri date.

View file

@ -6,7 +6,7 @@
# Interface: CalendarEngine
Defined in: [types.ts:42](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L42)
Defined in: [types.ts:42](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L42)
Interface every calendar engine must implement.
@ -21,7 +21,7 @@ the boundary gracefully without try/catch.
> `readonly` **id**: `string`
Defined in: [types.ts:43](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L43)
Defined in: [types.ts:43](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L43)
## Methods
@ -29,7 +29,7 @@ Defined in: [types.ts:43](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **daysInMonth**(`hy`, `hm`): `number`
Defined in: [types.ts:48](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L48)
Defined in: [types.ts:48](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L48)
#### Parameters
@ -51,7 +51,7 @@ Defined in: [types.ts:48](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **isValid**(`hy`, `hm`, `hd`): `boolean`
Defined in: [types.ts:47](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L47)
Defined in: [types.ts:47](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L47)
#### Parameters
@ -77,7 +77,7 @@ Defined in: [types.ts:47](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **toGregorian**(`hy`, `hm`, `hd`): `Date` \| `null`
Defined in: [types.ts:46](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L46)
Defined in: [types.ts:46](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L46)
Returns null for invalid or out-of-range input. Never throws.
@ -105,7 +105,7 @@ Returns null for invalid or out-of-range input. Never throws.
> **toHijri**(`date`): [`HijriDate`](HijriDate.md) \| `null`
Defined in: [types.ts:44](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L44)
Defined in: [types.ts:44](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L44)
#### Parameters

View file

@ -6,7 +6,7 @@
# Interface: ConversionOptions
Defined in: [types.ts:57](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L57)
Defined in: [types.ts:57](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L57)
Options accepted by the convenience conversion functions.
@ -19,4 +19,4 @@ Pass any name previously given to [registerCalendar](../functions/registerCalend
> `optional` **calendar?**: `string`
Defined in: [types.ts:58](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L58)
Defined in: [types.ts:58](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L58)

View file

@ -6,7 +6,7 @@
# Interface: HijriDate
Defined in: [types.ts:10](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L10)
Defined in: [types.ts:10](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L10)
A Hijri date triple.
@ -25,7 +25,7 @@ const d: HijriDate = { hy: 1446, hm: 9, hd: 1 }; // 1 Ramadan 1446 AH
> **hd**: `number`
Defined in: [types.ts:13](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L13)
Defined in: [types.ts:13](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L13)
***
@ -33,7 +33,7 @@ Defined in: [types.ts:13](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **hm**: `number`
Defined in: [types.ts:12](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L12)
Defined in: [types.ts:12](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L12)
***
@ -41,4 +41,4 @@ Defined in: [types.ts:12](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **hy**: `number`
Defined in: [types.ts:11](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L11)
Defined in: [types.ts:11](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L11)

View file

@ -6,7 +6,7 @@
# Interface: HijriYearRecord
Defined in: [types.ts:26](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L26)
Defined in: [types.ts:26](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L26)
One row in the Umm al-Qura reference table.
@ -23,7 +23,7 @@ bit i (0-indexed from bit 0) = month i+1; 1 = 30 days, 0 = 29 days.
> **dpm**: `number`
Defined in: [types.ts:28](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L28)
Defined in: [types.ts:28](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L28)
***
@ -31,7 +31,7 @@ Defined in: [types.ts:28](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **gd**: `number`
Defined in: [types.ts:31](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L31)
Defined in: [types.ts:31](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L31)
***
@ -39,7 +39,7 @@ Defined in: [types.ts:31](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **gm**: `number`
Defined in: [types.ts:30](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L30)
Defined in: [types.ts:30](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L30)
***
@ -47,7 +47,7 @@ Defined in: [types.ts:30](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **gy**: `number`
Defined in: [types.ts:29](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L29)
Defined in: [types.ts:29](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L29)
***
@ -55,4 +55,4 @@ Defined in: [types.ts:29](https://github.com/acamarata/hijri-core/blob/94bc28ebc
> **hy**: `number`
Defined in: [types.ts:27](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/types.ts#L27)
Defined in: [types.ts:27](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/types.ts#L27)

View file

@ -8,7 +8,7 @@
> `const` **MONTHS\_PER\_YEAR**: `12` = `12`
Defined in: [constants.ts:16](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/constants.ts#L16)
Defined in: [constants.ts:16](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/constants.ts#L16)
Number of months in a Hijri year.

View file

@ -8,7 +8,7 @@
> `const` **MS\_PER\_DAY**: `86400000` = `86_400_000`
Defined in: [constants.ts:8](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/constants.ts#L8)
Defined in: [constants.ts:8](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/constants.ts#L8)
Milliseconds in one day (24 * 60 * 60 * 1000).

View file

@ -8,4 +8,4 @@
> `const` **hDatesTable**: [`HijriYearRecord`](../interfaces/HijriYearRecord.md)[]
Defined in: [data/hDates.ts:7](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/data/hDates.ts#L7)
Defined in: [data/hDates.ts:7](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/data/hDates.ts#L7)

View file

@ -8,7 +8,7 @@
> `const` **hmLong**: `string`[]
Defined in: [names/months.ts:13](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/months.ts#L13)
Defined in: [names/months.ts:13](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/months.ts#L13)
Full English transliterations of the 12 Hijri month names.

View file

@ -8,7 +8,7 @@
> `const` **hmMedium**: `string`[]
Defined in: [names/months.ts:37](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/months.ts#L37)
Defined in: [names/months.ts:37](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/months.ts#L37)
Medium-length transliterations of the 12 Hijri month names.

View file

@ -8,7 +8,7 @@
> `const` **hmShort**: `string`[]
Defined in: [names/months.ts:61](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/months.ts#L61)
Defined in: [names/months.ts:61](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/months.ts#L61)
Three-character short codes for the 12 Hijri months.

View file

@ -8,7 +8,7 @@
> `const` **hwLong**: `string`[]
Defined in: [names/weekdays.ts:13](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/weekdays.ts#L13)
Defined in: [names/weekdays.ts:13](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/weekdays.ts#L13)
Full Arabic-transliterated names for the seven days of the week.

View file

@ -8,7 +8,7 @@
> `const` **hwNumeric**: `number`[]
Defined in: [names/weekdays.ts:50](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/weekdays.ts#L50)
Defined in: [names/weekdays.ts:50](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/weekdays.ts#L50)
Numeric weekday values: 1 = Sunday through 7 = Saturday.

View file

@ -8,7 +8,7 @@
> `const` **hwShort**: `string`[]
Defined in: [names/weekdays.ts:32](https://github.com/acamarata/hijri-core/blob/94bc28ebc35ae2f3cb39db5be34561152a5b899d/src/names/weekdays.ts#L32)
Defined in: [names/weekdays.ts:32](https://github.com/acamarata/hijri-core/blob/235ffb8851dac2e67cab33f1fc76cd8c00bbbe7c/src/names/weekdays.ts#L32)
Short single-word transliterations for the seven days of the week.