aric/hijri-core
1
0
Fork 0
mirror of https://github.com/acamarata/hijri-core.git synced 2026-06-30 18:54:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hijri-core/.github/wiki/api/interfaces/HijriYearRecord.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

1.4 KiB
Raw Blame History

hijri-core v1.0.1

hijri-core / HijriYearRecord

Interface: HijriYearRecord

Defined in: types.ts:26

One row in the Umm al-Qura reference table.

The table covers Hijri years 1318-1500 (Gregorian 1900-2076). A sentinel row at hy=1501 with dpm=0 marks the upper boundary and is used to detect out-of-range inputs without a separate bounds check.

The dpm bitmask encodes month lengths for all 12 months: bit i (0-indexed from bit 0) = month i+1; 1 = 30 days, 0 = 29 days.

Properties

dpm

dpm: number

Defined in: types.ts:28

gd

gd: number

Defined in: types.ts:31

gm

gm: number

Defined in: types.ts:30

gy

gy: number

Defined in: types.ts:29

hy

hy: number

Defined in: types.ts:27