mirror of
https://github.com/acamarata/luxon-hijri.git
synced 2026-07-02 03:30:42 +00:00
e663b343ac
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.
52 lines
877 B
Markdown
52 lines
877 B
Markdown
[**luxon-hijri v3.0.0**](../README.md)
|
|
|
|
***
|
|
|
|
[luxon-hijri](../README.md) / toGregorian
|
|
|
|
# Function: toGregorian()
|
|
|
|
> **toGregorian**(`hy`, `hm`, `hd`, `options?`): `Date`
|
|
|
|
Defined in: [src/toGregorian.ts:25](https://github.com/acamarata/luxon-hijri/blob/19dc465d7f7d279e07bf7505e42f4bba5f93ef3b/src/toGregorian.ts#L25)
|
|
|
|
Convert a Hijri date to a Gregorian Date object.
|
|
|
|
Unlike the hijri-core function (which returns null for invalid input), this
|
|
wrapper throws an Error so callers always receive a valid Date.
|
|
|
|
## Parameters
|
|
|
|
### hy
|
|
|
|
`number`
|
|
|
|
Hijri year
|
|
|
|
### hm
|
|
|
|
`number`
|
|
|
|
Hijri month (1-12)
|
|
|
|
### hd
|
|
|
|
`number`
|
|
|
|
Hijri day (1-30)
|
|
|
|
### options?
|
|
|
|
[`ConversionOptions`](../interfaces/ConversionOptions.md)
|
|
|
|
conversion options (calendar engine selection)
|
|
|
|
## Returns
|
|
|
|
`Date`
|
|
|
|
a UTC Date corresponding to the given Hijri date
|
|
|
|
## Throws
|
|
|
|
if the Hijri date is invalid or out of range
|