moon-sighting/.github/wiki/api/functions/getMoonPhase.md

moon-sighting v1.1.1

---

moon-sighting / getMoonPhase

Function: getMoonPhase()

getMoonPhase(date?): MoonPhaseResult

Defined in: api/index.ts:487

Compute the Moon's current phase, illumination, and next phase times.

Works WITHOUT a kernel (uses Meeus approximation).

Parameters

date?

Date = ...

Date to compute phase for (default: now)

Returns

MoonPhaseResult

MoonPhaseResult with illumination, phase name, age, and next events

Example

const phase = getMoonPhase(new Date())
console.log(phase.phase)       // 'waxing-crescent'
console.log(phase.phaseName)   // 'Waxing Crescent'
console.log(phase.phaseSymbol) // '🌒'
console.log(phase.illumination)// 14.3 (percent)
console.log(phase.nextFullMoon)// Date object