diff --git a/.github/wiki/api/functions/daysInHijriMonth.md b/.github/wiki/api/functions/daysInHijriMonth.md index 8677ecd..312772c 100644 --- a/.github/wiki/api/functions/daysInHijriMonth.md +++ b/.github/wiki/api/functions/daysInHijriMonth.md @@ -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. diff --git a/.github/wiki/api/functions/getCalendar.md b/.github/wiki/api/functions/getCalendar.md index 1b8198d..281cd02 100644 --- a/.github/wiki/api/functions/getCalendar.md +++ b/.github/wiki/api/functions/getCalendar.md @@ -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. diff --git a/.github/wiki/api/functions/isValidHijriDate.md b/.github/wiki/api/functions/isValidHijriDate.md index bdb1b40..411fbea 100644 --- a/.github/wiki/api/functions/isValidHijriDate.md +++ b/.github/wiki/api/functions/isValidHijriDate.md @@ -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. diff --git a/.github/wiki/api/functions/listCalendars.md b/.github/wiki/api/functions/listCalendars.md index c515921..a4b6c60 100644 --- a/.github/wiki/api/functions/listCalendars.md +++ b/.github/wiki/api/functions/listCalendars.md @@ -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. diff --git a/.github/wiki/api/functions/registerCalendar.md b/.github/wiki/api/functions/registerCalendar.md index 132111f..19601ff 100644 --- a/.github/wiki/api/functions/registerCalendar.md +++ b/.github/wiki/api/functions/registerCalendar.md @@ -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. diff --git a/.github/wiki/api/functions/toGregorian.md b/.github/wiki/api/functions/toGregorian.md index c302d1b..87ede01 100644 --- a/.github/wiki/api/functions/toGregorian.md +++ b/.github/wiki/api/functions/toGregorian.md @@ -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. diff --git a/.github/wiki/api/functions/toHijri.md b/.github/wiki/api/functions/toHijri.md index 314be36..d5c950a 100644 --- a/.github/wiki/api/functions/toHijri.md +++ b/.github/wiki/api/functions/toHijri.md @@ -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. diff --git a/.github/wiki/api/interfaces/CalendarEngine.md b/.github/wiki/api/interfaces/CalendarEngine.md index af7dda7..f01278a 100644 --- a/.github/wiki/api/interfaces/CalendarEngine.md +++ b/.github/wiki/api/interfaces/CalendarEngine.md @@ -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 diff --git a/.github/wiki/api/interfaces/ConversionOptions.md b/.github/wiki/api/interfaces/ConversionOptions.md index 206c6be..ec0634f 100644 --- a/.github/wiki/api/interfaces/ConversionOptions.md +++ b/.github/wiki/api/interfaces/ConversionOptions.md @@ -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) diff --git a/.github/wiki/api/interfaces/HijriDate.md b/.github/wiki/api/interfaces/HijriDate.md index 865bcc0..0975d79 100644 --- a/.github/wiki/api/interfaces/HijriDate.md +++ b/.github/wiki/api/interfaces/HijriDate.md @@ -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) diff --git a/.github/wiki/api/interfaces/HijriYearRecord.md b/.github/wiki/api/interfaces/HijriYearRecord.md index 087730a..a52c313 100644 --- a/.github/wiki/api/interfaces/HijriYearRecord.md +++ b/.github/wiki/api/interfaces/HijriYearRecord.md @@ -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) diff --git a/.github/wiki/api/variables/MONTHS_PER_YEAR.md b/.github/wiki/api/variables/MONTHS_PER_YEAR.md index 4d7021f..f3eb2aa 100644 --- a/.github/wiki/api/variables/MONTHS_PER_YEAR.md +++ b/.github/wiki/api/variables/MONTHS_PER_YEAR.md @@ -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. diff --git a/.github/wiki/api/variables/MS_PER_DAY.md b/.github/wiki/api/variables/MS_PER_DAY.md index 3368f4f..e82bf0b 100644 --- a/.github/wiki/api/variables/MS_PER_DAY.md +++ b/.github/wiki/api/variables/MS_PER_DAY.md @@ -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). diff --git a/.github/wiki/api/variables/hDatesTable.md b/.github/wiki/api/variables/hDatesTable.md index 3a57794..51e07a4 100644 --- a/.github/wiki/api/variables/hDatesTable.md +++ b/.github/wiki/api/variables/hDatesTable.md @@ -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) diff --git a/.github/wiki/api/variables/hmLong.md b/.github/wiki/api/variables/hmLong.md index cb0433f..279e04b 100644 --- a/.github/wiki/api/variables/hmLong.md +++ b/.github/wiki/api/variables/hmLong.md @@ -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. diff --git a/.github/wiki/api/variables/hmMedium.md b/.github/wiki/api/variables/hmMedium.md index cada3e6..5ffc497 100644 --- a/.github/wiki/api/variables/hmMedium.md +++ b/.github/wiki/api/variables/hmMedium.md @@ -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. diff --git a/.github/wiki/api/variables/hmShort.md b/.github/wiki/api/variables/hmShort.md index 6fec24d..594b5fd 100644 --- a/.github/wiki/api/variables/hmShort.md +++ b/.github/wiki/api/variables/hmShort.md @@ -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. diff --git a/.github/wiki/api/variables/hwLong.md b/.github/wiki/api/variables/hwLong.md index 367ba94..b2d6e3d 100644 --- a/.github/wiki/api/variables/hwLong.md +++ b/.github/wiki/api/variables/hwLong.md @@ -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. diff --git a/.github/wiki/api/variables/hwNumeric.md b/.github/wiki/api/variables/hwNumeric.md index 010a074..ee6831c 100644 --- a/.github/wiki/api/variables/hwNumeric.md +++ b/.github/wiki/api/variables/hwNumeric.md @@ -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. diff --git a/.github/wiki/api/variables/hwShort.md b/.github/wiki/api/variables/hwShort.md index 231bdb7..77058d4 100644 --- a/.github/wiki/api/variables/hwShort.md +++ b/.github/wiki/api/variables/hwShort.md @@ -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.