date-fns-hijri/.github/wiki/api/functions/getHijriMonth.md

29 lines
576 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[**date-fns-hijri v1.0.1**](../README.md)
***
[date-fns-hijri](../README.md) / getHijriMonth
# Function: getHijriMonth()
> **getHijriMonth**(`date`, `options?`): `number` \| `null`
Defined in: [src/index.ts:89](https://github.com/acamarata/date-fns-hijri/blob/e8ade1f9c489d2317f2f324f2a54bebcb30e4d6f/src/index.ts#L89)
Get the Hijri month (112) 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`