mirror of
https://github.com/acamarata/date-fns-hijri.git
synced 2026-07-01 19:24:26 +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.
35 lines
580 B
Markdown
35 lines
580 B
Markdown
[**date-fns-hijri v1.0.1**](../README.md)
|
||
|
||
***
|
||
|
||
[date-fns-hijri](../README.md) / getHijriMonthName
|
||
|
||
# Function: getHijriMonthName()
|
||
|
||
> **getHijriMonthName**(`hm`, `length?`): `string`
|
||
|
||
Defined in: [src/index.ts:123](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L123)
|
||
|
||
Get the English name of a Hijri month.
|
||
|
||
## Parameters
|
||
|
||
### hm
|
||
|
||
`number`
|
||
|
||
Month number (1–12).
|
||
|
||
### length?
|
||
|
||
`"long"` \| `"medium"` \| `"short"`
|
||
|
||
`'long'` (default), `'medium'`, or `'short'`.
|
||
|
||
## Returns
|
||
|
||
`string`
|
||
|
||
## Throws
|
||
|
||
If `hm` is not in [1, 12].
|