mirror of https://github.com/acamarata/moon-sighting.git synced 2026-06-30 19:04:24 +00:00

Aric Camarata 2992dcee21 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

moon-sighting v1.1.1

moon-sighting / MoonIlluminationResult

Interface: MoonIlluminationResult

Defined in: types.ts:47

Moon illumination from getMoonIllumination(). Computed via Meeus Ch. 47/48 (no kernel required). Accuracy: fraction ~0.5%, phase fraction ~0.003.

Properties

angle

angle: number

Defined in: types.ts:59

Position angle of the midpoint of the bright limb, measured eastward from the north celestial pole, in radians. Matches the suncalc convention.

fraction

fraction: number

Defined in: types.ts:49

Illuminated fraction of the Moon disk, 0 (new moon) to 1 (full moon)

isWaxing

isWaxing: boolean

Defined in: types.ts:61

True while elongation is increasing (new moon toward full moon)

phase

phase: number

Defined in: types.ts:54

Phase cycle fraction in [0, 1): 0 = new moon, 0.25 = first quarter, 0.5 = full moon, 0.75 = last quarter

1.5 KiB Raw Blame History