mirror of
https://github.com/acamarata/moon-sighting.git
synced 2026-06-30 19:04: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.
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
[**moon-sighting v1.1.1**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-sighting](../README.md) / MoonSnapshot
|
|
|
|
# Interface: MoonSnapshot
|
|
|
|
Defined in: [types.ts:277](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L277)
|
|
|
|
Combined kernel-free moon snapshot from getMoon().
|
|
Bundles phase, position, illumination, and a quick visibility estimate
|
|
into a single call.
|
|
|
|
## Properties
|
|
|
|
### illumination
|
|
|
|
> **illumination**: [`MoonIlluminationResult`](MoonIlluminationResult.md)
|
|
|
|
Defined in: [types.ts:283](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L283)
|
|
|
|
Illumination fraction, phase cycle, bright limb angle, waxing/waning
|
|
|
|
***
|
|
|
|
### phase
|
|
|
|
> **phase**: [`MoonPhaseResult`](MoonPhaseResult.md)
|
|
|
|
Defined in: [types.ts:279](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L279)
|
|
|
|
Phase name, illumination, age, and next events
|
|
|
|
***
|
|
|
|
### position
|
|
|
|
> **position**: [`MoonPosition`](MoonPosition.md)
|
|
|
|
Defined in: [types.ts:281](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L281)
|
|
|
|
Topocentric az/alt, distance, parallactic angle
|
|
|
|
***
|
|
|
|
### visibility
|
|
|
|
> **visibility**: [`MoonVisibilityEstimate`](MoonVisibilityEstimate.md)
|
|
|
|
Defined in: [types.ts:285](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L285)
|
|
|
|
Quick Odeh-based crescent visibility estimate
|