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.
29 lines
563 B
Markdown
29 lines
563 B
Markdown
[**date-fns-hijri v1.0.1**](../README.md)
|
|
|
|
***
|
|
|
|
[date-fns-hijri](../README.md) / getHijriYear
|
|
|
|
# Function: getHijriYear()
|
|
|
|
> **getHijriYear**(`date`, `options?`): `number` \| `null`
|
|
|
|
Defined in: [src/index.ts:80](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L80)
|
|
|
|
Get the Hijri year for a Gregorian date.
|
|
|
|
Returns `null` when the date is outside the supported range.
|
|
|
|
## Parameters
|
|
|
|
### date
|
|
|
|
`Date`
|
|
|
|
### options?
|
|
|
|
[`ConversionOptions`](../interfaces/ConversionOptions.md)
|
|
|
|
## Returns
|
|
|
|
`number` \| `null`
|