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

41 lines
680 B
Markdown

[**date-fns-hijri v1.0.1**](../README.md)
***
[date-fns-hijri](../README.md) / fromHijriDate
# Function: fromHijriDate()
> **fromHijriDate**(`hy`, `hm`, `hd`, `options?`): `Date`
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`.
The returned `Date` is set to midnight UTC of the equivalent Gregorian day.
## Parameters
### hy
`number`
### hm
`number`
### hd
`number`
### options?
[`ConversionOptions`](../interfaces/ConversionOptions.md)
## Returns
`Date`
## Throws
If the Hijri date is invalid or outside the calendar's range.