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.
41 lines
882 B
Markdown
41 lines
882 B
Markdown
[**moon-sighting v1.1.1**](../README.md)
|
|
|
|
***
|
|
|
|
[moon-sighting](../README.md) / getSunMoonEvents
|
|
|
|
# Function: getSunMoonEvents()
|
|
|
|
> **getSunMoonEvents**(`date`, `observer`, `options?`): `Promise`\<[`SunMoonEvents`](../interfaces/SunMoonEvents.md)\>
|
|
|
|
Defined in: [api/index.ts:833](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L833)
|
|
|
|
Get rise, set, and twilight times for the Sun and Moon on a given date.
|
|
|
|
Requires initKernels() for accurate results.
|
|
|
|
## Parameters
|
|
|
|
### date
|
|
|
|
`Date`
|
|
|
|
Date to compute events for
|
|
|
|
### observer
|
|
|
|
[`Observer`](../interfaces/Observer.md)
|
|
|
|
Observer location
|
|
|
|
### options?
|
|
|
|
`Pick`\<[`SightingOptions`](../interfaces/SightingOptions.md), `"kernels"`\>
|
|
|
|
Optional kernel configuration
|
|
|
|
## Returns
|
|
|
|
`Promise`\<[`SunMoonEvents`](../interfaces/SunMoonEvents.md)\>
|
|
|
|
SunMoonEvents with all times in UTC
|