From 9859725e64623b991b3fd0e42559aa020dafcb1b Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Sat, 30 May 2026 17:48:47 -0400 Subject: [PATCH] docs: refresh TypeDoc API output (T-E8-03 QA-A verify) --- .github/wiki/api/functions/addHijriMonths.md | 2 +- .github/wiki/api/functions/addHijriYears.md | 2 +- .github/wiki/api/functions/endOfHijriMonth.md | 2 +- .github/wiki/api/functions/formatHijriDate.md | 2 +- .github/wiki/api/functions/fromHijriDate.md | 2 +- .github/wiki/api/functions/getDaysInHijriMonth.md | 2 +- .github/wiki/api/functions/getHijriDay.md | 2 +- .github/wiki/api/functions/getHijriMonth.md | 2 +- .github/wiki/api/functions/getHijriMonthName.md | 2 +- .github/wiki/api/functions/getHijriQuarter.md | 2 +- .github/wiki/api/functions/getHijriWeekdayName.md | 2 +- .github/wiki/api/functions/getHijriYear.md | 2 +- .github/wiki/api/functions/isSameHijriMonth.md | 2 +- .github/wiki/api/functions/isSameHijriYear.md | 2 +- .github/wiki/api/functions/isValidHijriDate.md | 2 +- .github/wiki/api/functions/startOfHijriMonth.md | 2 +- .github/wiki/api/functions/toHijriDate.md | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/wiki/api/functions/addHijriMonths.md b/.github/wiki/api/functions/addHijriMonths.md index 1febf2f..6cad04b 100644 --- a/.github/wiki/api/functions/addHijriMonths.md +++ b/.github/wiki/api/functions/addHijriMonths.md @@ -8,7 +8,7 @@ > **addHijriMonths**(`date`, `months`, `options?`): `Date` -Defined in: [src/index.ts:267](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L267) +Defined in: [src/index.ts:267](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L267) Add a number of Hijri months to a Gregorian date. diff --git a/.github/wiki/api/functions/addHijriYears.md b/.github/wiki/api/functions/addHijriYears.md index eee7f0c..efc8c8a 100644 --- a/.github/wiki/api/functions/addHijriYears.md +++ b/.github/wiki/api/functions/addHijriYears.md @@ -8,7 +8,7 @@ > **addHijriYears**(`date`, `years`, `options?`): `Date` -Defined in: [src/index.ts:293](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L293) +Defined in: [src/index.ts:293](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L293) Add a number of Hijri years to a Gregorian date. diff --git a/.github/wiki/api/functions/endOfHijriMonth.md b/.github/wiki/api/functions/endOfHijriMonth.md index b349926..4926675 100644 --- a/.github/wiki/api/functions/endOfHijriMonth.md +++ b/.github/wiki/api/functions/endOfHijriMonth.md @@ -8,7 +8,7 @@ > **endOfHijriMonth**(`date`, `options?`): `Date` -Defined in: [src/index.ts:328](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L328) +Defined in: [src/index.ts:328](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L328) Get the last day of the Hijri month that contains the given date. diff --git a/.github/wiki/api/functions/formatHijriDate.md b/.github/wiki/api/functions/formatHijriDate.md index c168c2d..cf6ee8a 100644 --- a/.github/wiki/api/functions/formatHijriDate.md +++ b/.github/wiki/api/functions/formatHijriDate.md @@ -8,7 +8,7 @@ > **formatHijriDate**(`date`, `formatStr`, `options?`): `string` -Defined in: [src/index.ts:185](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L185) +Defined in: [src/index.ts:185](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L185) Format a Gregorian date using Hijri calendar tokens. diff --git a/.github/wiki/api/functions/fromHijriDate.md b/.github/wiki/api/functions/fromHijriDate.md index 1655727..7d98bd7 100644 --- a/.github/wiki/api/functions/fromHijriDate.md +++ b/.github/wiki/api/functions/fromHijriDate.md @@ -8,7 +8,7 @@ > **fromHijriDate**(`hy`, `hm`, `hd`, `options?`): `Date` -Defined in: [src/index.ts:39](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L39) +Defined in: [src/index.ts:39](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L39) Convert a Hijri date to a Gregorian `Date`. diff --git a/.github/wiki/api/functions/getDaysInHijriMonth.md b/.github/wiki/api/functions/getDaysInHijriMonth.md index cc0616d..832ad5f 100644 --- a/.github/wiki/api/functions/getDaysInHijriMonth.md +++ b/.github/wiki/api/functions/getDaysInHijriMonth.md @@ -8,7 +8,7 @@ > **getDaysInHijriMonth**(`hy`, `hm`, `options?`): `number` -Defined in: [src/index.ts:107](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L107) +Defined in: [src/index.ts:107](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L107) Get the number of days in a Hijri month (29 or 30). diff --git a/.github/wiki/api/functions/getHijriDay.md b/.github/wiki/api/functions/getHijriDay.md index e27bc05..ec56921 100644 --- a/.github/wiki/api/functions/getHijriDay.md +++ b/.github/wiki/api/functions/getHijriDay.md @@ -8,7 +8,7 @@ > **getHijriDay**(`date`, `options?`): `number` \| `null` -Defined in: [src/index.ts:98](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L98) +Defined in: [src/index.ts:98](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L98) Get the Hijri day of month (1–30) for a Gregorian date. diff --git a/.github/wiki/api/functions/getHijriMonth.md b/.github/wiki/api/functions/getHijriMonth.md index d8376d9..4dc282c 100644 --- a/.github/wiki/api/functions/getHijriMonth.md +++ b/.github/wiki/api/functions/getHijriMonth.md @@ -8,7 +8,7 @@ > **getHijriMonth**(`date`, `options?`): `number` \| `null` -Defined in: [src/index.ts:89](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L89) +Defined in: [src/index.ts:89](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L89) Get the Hijri month (1–12) for a Gregorian date. diff --git a/.github/wiki/api/functions/getHijriMonthName.md b/.github/wiki/api/functions/getHijriMonthName.md index 7e4ff78..8f75b0c 100644 --- a/.github/wiki/api/functions/getHijriMonthName.md +++ b/.github/wiki/api/functions/getHijriMonthName.md @@ -8,7 +8,7 @@ > **getHijriMonthName**(`hm`, `length?`): `string` -Defined in: [src/index.ts:123](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L123) +Defined in: [src/index.ts:123](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L123) Get the English name of a Hijri month. diff --git a/.github/wiki/api/functions/getHijriQuarter.md b/.github/wiki/api/functions/getHijriQuarter.md index fc07e47..b7d30c1 100644 --- a/.github/wiki/api/functions/getHijriQuarter.md +++ b/.github/wiki/api/functions/getHijriQuarter.md @@ -8,7 +8,7 @@ > **getHijriQuarter**(`date`, `options?`): `number` \| `null` -Defined in: [src/index.ts:376](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L376) +Defined in: [src/index.ts:376](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L376) Get the Hijri quarter (1–4) for a Gregorian date. diff --git a/.github/wiki/api/functions/getHijriWeekdayName.md b/.github/wiki/api/functions/getHijriWeekdayName.md index bb5be09..66d3069 100644 --- a/.github/wiki/api/functions/getHijriWeekdayName.md +++ b/.github/wiki/api/functions/getHijriWeekdayName.md @@ -8,7 +8,7 @@ > **getHijriWeekdayName**(`date`, `length?`): `string` -Defined in: [src/index.ts:148](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L148) +Defined in: [src/index.ts:148](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L148) Get the Arabic weekday name for a Gregorian date. diff --git a/.github/wiki/api/functions/getHijriYear.md b/.github/wiki/api/functions/getHijriYear.md index 7b35088..e03ad01 100644 --- a/.github/wiki/api/functions/getHijriYear.md +++ b/.github/wiki/api/functions/getHijriYear.md @@ -8,7 +8,7 @@ > **getHijriYear**(`date`, `options?`): `number` \| `null` -Defined in: [src/index.ts:80](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L80) +Defined in: [src/index.ts:80](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L80) Get the Hijri year for a Gregorian date. diff --git a/.github/wiki/api/functions/isSameHijriMonth.md b/.github/wiki/api/functions/isSameHijriMonth.md index efcc00d..f8dab85 100644 --- a/.github/wiki/api/functions/isSameHijriMonth.md +++ b/.github/wiki/api/functions/isSameHijriMonth.md @@ -8,7 +8,7 @@ > **isSameHijriMonth**(`dateA`, `dateB`, `options?`): `boolean` -Defined in: [src/index.ts:346](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L346) +Defined in: [src/index.ts:346](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L346) Check whether two Gregorian dates fall in the same Hijri month. diff --git a/.github/wiki/api/functions/isSameHijriYear.md b/.github/wiki/api/functions/isSameHijriYear.md index acc1266..5885c05 100644 --- a/.github/wiki/api/functions/isSameHijriYear.md +++ b/.github/wiki/api/functions/isSameHijriYear.md @@ -8,7 +8,7 @@ > **isSameHijriYear**(`dateA`, `dateB`, `options?`): `boolean` -Defined in: [src/index.ts:358](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L358) +Defined in: [src/index.ts:358](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L358) Check whether two Gregorian dates fall in the same Hijri year. diff --git a/.github/wiki/api/functions/isValidHijriDate.md b/.github/wiki/api/functions/isValidHijriDate.md index 05323c1..f86da6f 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: [src/index.ts:62](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L62) +Defined in: [src/index.ts:62](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L62) Check whether a Hijri date is valid for the given calendar system. diff --git a/.github/wiki/api/functions/startOfHijriMonth.md b/.github/wiki/api/functions/startOfHijriMonth.md index 78b0284..86a8a5a 100644 --- a/.github/wiki/api/functions/startOfHijriMonth.md +++ b/.github/wiki/api/functions/startOfHijriMonth.md @@ -8,7 +8,7 @@ > **startOfHijriMonth**(`date`, `options?`): `Date` -Defined in: [src/index.ts:315](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L315) +Defined in: [src/index.ts:315](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L315) Get the first day of the Hijri month that contains the given date. diff --git a/.github/wiki/api/functions/toHijriDate.md b/.github/wiki/api/functions/toHijriDate.md index 6627ea7..74c2328 100644 --- a/.github/wiki/api/functions/toHijriDate.md +++ b/.github/wiki/api/functions/toHijriDate.md @@ -8,7 +8,7 @@ > **toHijriDate**(`date`, `options?`): [`HijriDate`](../interfaces/HijriDate.md) \| `null` -Defined in: [src/index.ts:28](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L28) +Defined in: [src/index.ts:28](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L28) Convert a Gregorian `Date` to a Hijri date object.