aric/date-fns-hijri
1
0
Fork 0
mirror of https://github.com/acamarata/date-fns-hijri.git synced 2026-07-04 20:50:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Aric Camarata 2026-05-30 17:48:47 -04:00
parent e8ade1f9c4
commit 9859725e64
17 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/wiki/api/functions/addHijriMonths.md vendored
View file

@ -8,7 +8,7 @@
> **addHijriMonths**(`date`, `months`, `options?`): `Date` > **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. Add a number of Hijri months to a Gregorian date.

2
.github/wiki/api/functions/addHijriYears.md vendored
View file

@ -8,7 +8,7 @@
> **addHijriYears**(`date`, `years`, `options?`): `Date` > **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. Add a number of Hijri years to a Gregorian date.

2
.github/wiki/api/functions/endOfHijriMonth.md vendored
View file

@ -8,7 +8,7 @@
> **endOfHijriMonth**(`date`, `options?`): `Date` > **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. Get the last day of the Hijri month that contains the given date.

2
.github/wiki/api/functions/formatHijriDate.md vendored
View file

@ -8,7 +8,7 @@
> **formatHijriDate**(`date`, `formatStr`, `options?`): `string` > **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. Format a Gregorian date using Hijri calendar tokens.

2
.github/wiki/api/functions/fromHijriDate.md vendored
View file

@ -8,7 +8,7 @@
> **fromHijriDate**(`hy`, `hm`, `hd`, `options?`): `Date` > **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`. Convert a Hijri date to a Gregorian `Date`.

2
.github/wiki/api/functions/getDaysInHijriMonth.md vendored
View file

@ -8,7 +8,7 @@
> **getDaysInHijriMonth**(`hy`, `hm`, `options?`): `number` > **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). Get the number of days in a Hijri month (29 or 30).

2
.github/wiki/api/functions/getHijriDay.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriDay**(`date`, `options?`): `number` \| `null` > **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. Get the Hijri day of month (1–30) for a Gregorian date.

2
.github/wiki/api/functions/getHijriMonth.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriMonth**(`date`, `options?`): `number` \| `null` > **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. Get the Hijri month (1–12) for a Gregorian date.

2
.github/wiki/api/functions/getHijriMonthName.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriMonthName**(`hm`, `length?`): `string` > **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. Get the English name of a Hijri month.

2
.github/wiki/api/functions/getHijriQuarter.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriQuarter**(`date`, `options?`): `number` \| `null` > **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. Get the Hijri quarter (1–4) for a Gregorian date.

2
.github/wiki/api/functions/getHijriWeekdayName.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriWeekdayName**(`date`, `length?`): `string` > **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. Get the Arabic weekday name for a Gregorian date.

2
.github/wiki/api/functions/getHijriYear.md vendored
View file

@ -8,7 +8,7 @@
> **getHijriYear**(`date`, `options?`): `number` \| `null` > **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. Get the Hijri year for a Gregorian date.

2
.github/wiki/api/functions/isSameHijriMonth.md vendored
View file

@ -8,7 +8,7 @@
> **isSameHijriMonth**(`dateA`, `dateB`, `options?`): `boolean` > **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. Check whether two Gregorian dates fall in the same Hijri month.

2
.github/wiki/api/functions/isSameHijriYear.md vendored
View file

@ -8,7 +8,7 @@
> **isSameHijriYear**(`dateA`, `dateB`, `options?`): `boolean` > **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. Check whether two Gregorian dates fall in the same Hijri year.

2
.github/wiki/api/functions/isValidHijriDate.md vendored
View file

@ -8,7 +8,7 @@
> **isValidHijriDate**(`hy`, `hm`, `hd`, `options?`): `boolean` > **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. Check whether a Hijri date is valid for the given calendar system.

2
.github/wiki/api/functions/startOfHijriMonth.md vendored
View file

@ -8,7 +8,7 @@
> **startOfHijriMonth**(`date`, `options?`): `Date` > **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. Get the first day of the Hijri month that contains the given date.

2
.github/wiki/api/functions/toHijriDate.md vendored
View file

@ -8,7 +8,7 @@
> **toHijriDate**(`date`, `options?`): [`HijriDate`](../interfaces/HijriDate.md) \| `null` > **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. Convert a Gregorian `Date` to a Hijri date object.