mirror of
https://github.com/acamarata/date-fns-hijri.git
synced 2026-07-02 11:40:40 +00:00
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/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/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`
|