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

Aric Camarata e8ade1f9c4 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:59 -04:00

1.5 KiB

Raw Blame History

date-fns-hijri v1.0.1

date-fns-hijri / formatHijriDate

Function: formatHijriDate()

formatHijriDate(date, formatStr, options?): string

Defined in: src/index.ts:185

Format a Gregorian date using Hijri calendar tokens.

Supported tokens:

Token	Output	Example
iYYYY	4-digit Hijri year	1444
iYY	2-digit Hijri year	44
iMMMM	Long month name	Ramadan
iMMM	Medium month name	Ramadan
iMM	Zero-padded month (01–12)	09
iM	Month (1–12)	9
iDD	Zero-padded day (01–30)	01
iD	Day (1–30)	1
iEEEE	Long weekday name	Yawm al-Khamis
iEEE	Short weekday name	Kham
iE	Numeric weekday (1=Sun–7=Sat)	5
ioooo	Long era	AH
iooo	Short era	AH

Returns an empty string when the date falls outside the supported range.

Parameters

date

Date

formatStr

string

options?

ConversionOptions

Returns