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 / getMoonSightingReport

Function: getMoonSightingReport()

getMoonSightingReport(date, observer, options?): Promise<MoonSightingReport>

Defined in: api/index.ts:306

Compute a complete moon sighting report for a date and location.

Returns all quantities needed for Islamic crescent sighting determination: sunset/moonset times, best observation time, crescent geometry (ARCL, ARCV, DAZ, W, Lag), Yallop category, Odeh zone, and plain-language guidance.

Requires initKernels() to have been called first (or pass kernels in options).

Parameters

date

Date

Date to check (UTC midnight or any time on that civil day)

observer

Observer

Observer location and environmental parameters

options?

SightingOptions

Optional configuration for refraction model, best-time method, etc.

Returns

Promise<MoonSightingReport>

Complete MoonSightingReport

Example

await initKernels()
const report = await getMoonSightingReport(new Date('2025-03-01'), {
  lat: 51.5074, lon: -0.1278, elevation: 10, name: 'London'
})
console.log(report.yallop.category)  // 'A' through 'F'
console.log(report.guidance)         // "Best time to look: ..."

1.5 KiB Raw Blame History