aric/moon-sighting

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

2.5 KiB

Raw Blame History

moon-sighting v1.1.1

moon-sighting / MoonPhaseResult

Interface: MoonPhaseResult

Defined in: types.ts:300

Properties

age

age: number

Defined in: types.ts:310

Hours since last new moon

elongationDeg

elongationDeg: number

Defined in: types.ts:312

Ecliptic longitude of the Moon minus the Sun, degrees [0, 360)

illumination

illumination: number

Defined in: types.ts:308

Illuminated fraction 0-100 (percent)

isWaxing

isWaxing: boolean

Defined in: types.ts:314

True when Moon is moving away from the Sun (illumination increasing)

nextFullMoon

nextFullMoon: Date

Defined in: types.ts:318

UTC date of the next full moon

nextNewMoon

nextNewMoon: Date

Defined in: types.ts:316

UTC date of the next new moon

phase

phase: MoonPhaseName

Defined in: types.ts:302

Named phase based on illumination and waxing/waning state

phaseName

phaseName: string

Defined in: types.ts:304

Human-readable phase name, e.g. "Waxing Crescent"

phaseSymbol

phaseSymbol: string

Defined in: types.ts:306

Moon phase emoji symbol, e.g. "🌒"

prevNewMoon

prevNewMoon: Date

Defined in: types.ts:320

UTC date of the previous new moon