mirror of
https://github.com/acamarata/moon-sighting.git
synced 2026-07-01 03:14:24 +00:00
2992dcee21
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.
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
[**moon-sighting v1.1.1**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-sighting](../README.md) / getMoonSightingReport
|
|
|
|
# Function: getMoonSightingReport()
|
|
|
|
> **getMoonSightingReport**(`date`, `observer`, `options?`): `Promise`\<[`MoonSightingReport`](../interfaces/MoonSightingReport.md)\>
|
|
|
|
Defined in: [api/index.ts:306](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L306)
|
|
|
|
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`](../interfaces/Observer.md)
|
|
|
|
Observer location and environmental parameters
|
|
|
|
### options?
|
|
|
|
[`SightingOptions`](../interfaces/SightingOptions.md)
|
|
|
|
Optional configuration for refraction model, best-time method, etc.
|
|
|
|
## Returns
|
|
|
|
`Promise`\<[`MoonSightingReport`](../interfaces/MoonSightingReport.md)\>
|
|
|
|
Complete MoonSightingReport
|
|
|
|
## Example
|
|
|
|
```ts
|
|
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: ..."
|
|
```
|