mirror of
https://github.com/acamarata/date-fns-hijri.git
synced 2026-06-30 18:54:25 +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.
33 lines
595 B
Markdown
33 lines
595 B
Markdown
[**date-fns-hijri v1.0.1**](../README.md)
|
|
|
|
***
|
|
|
|
[date-fns-hijri](../README.md) / getHijriWeekdayName
|
|
|
|
# Function: getHijriWeekdayName()
|
|
|
|
> **getHijriWeekdayName**(`date`, `length?`): `string`
|
|
|
|
Defined in: [src/index.ts:148](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L148)
|
|
|
|
Get the Arabic weekday name for a Gregorian date.
|
|
|
|
Uses `Date.getDay()` (0 = Sunday, 6 = Saturday) as the index.
|
|
|
|
## Parameters
|
|
|
|
### date
|
|
|
|
`Date`
|
|
|
|
Any Gregorian `Date`.
|
|
|
|
### length?
|
|
|
|
`"long"` \| `"short"`
|
|
|
|
`'long'` (default) or `'short'`.
|
|
|
|
## Returns
|
|
|
|
`string`
|