aric/hijri-core

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

Aric Camarata 235ffb8851 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

883 B

Raw Blame History

hijri-core v1.0.1

hijri-core / toHijri

Function: toHijri()

toHijri(date, options?): HijriDate | null

Defined in: index.ts:42

Convert a Gregorian date to a Hijri date.

Uses the UAQ (Umm al-Qura) calendar by default. Pass { calendar: 'fcna' } or any registered calendar name via options to use a different engine.

Parameters

date

Date

a valid JavaScript Date object

options?

ConversionOptions

conversion options (calendar engine selection)

Returns

HijriDate | null

the corresponding Hijri date, or null if the date is out of range

Throws

if date is not a valid Date instance