hijri-core/.github/wiki/api/functions/registerCalendar.md
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

779 B

hijri-core v1.0.1


hijri-core / registerCalendar

Function: registerCalendar()

registerCalendar(name, engine): void

Defined in: registry.ts:14

Register a calendar engine under the given name.

Once registered, the engine can be selected via { calendar: name } in any conversion function or retrieved directly with getCalendar.

Parameters

name

string

unique identifier for the calendar (e.g. 'uaq', 'fcna')

engine

CalendarEngine

an object implementing the CalendarEngine interface

Returns

void