mirror of
https://github.com/acamarata/date-fns-hijri.git
synced 2026-07-02 03:30:39 +00:00
e8ade1f9c4
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.
30 lines
720 B
Markdown
30 lines
720 B
Markdown
[**date-fns-hijri v1.0.1**](../README.md)
|
||
|
||
***
|
||
|
||
[date-fns-hijri](../README.md) / toHijriDate
|
||
|
||
# Function: toHijriDate()
|
||
|
||
> **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)
|
||
|
||
Convert a Gregorian `Date` to a Hijri date object.
|
||
|
||
Returns `null` when the date falls outside the calendar's supported range
|
||
(UAQ: 1318–1500 AH / 1900–2076 CE; FCNA extends slightly further).
|
||
|
||
## Parameters
|
||
|
||
### date
|
||
|
||
`Date`
|
||
|
||
### options?
|
||
|
||
[`ConversionOptions`](../interfaces/ConversionOptions.md)
|
||
|
||
## Returns
|
||
|
||
[`HijriDate`](../interfaces/HijriDate.md) \| `null`
|