mirror of https://github.com/acamarata/luxon-hijri.git synced 2026-06-30 18:54:28 +00:00

Aric Camarata e663b343ac docs: add TypeDoc API generation (typedoc@0.28.19 + typedoc-plugin-markdown@4.11.0)

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.

2026-05-30 16:41:58 -04:00

853 B

Raw Blame History

luxon-hijri v3.0.0

luxon-hijri / formatHijriDate

Function: formatHijriDate()

formatHijriDate(hijriDate, format): string

Defined in: src/formatHijriDate.ts:24

Format a Hijri date using a token-based format string.

Hijri-specific tokens use the i prefix (iYYYY, iMM, iDD, iEEEE, etc.). Time and timezone tokens (HH, mm, ss, a, Z, z) are delegated to Luxon via the corresponding Gregorian date.

Parameters

hijriDate

HijriDate

the Hijri date to format

format

string

a format string containing Hijri and/or Luxon tokens

Returns

string

the formatted date string

Throws

if the Hijri month is outside the 1-12 range

853 B Raw Blame History