docs: refresh TypeDoc API output (T-E8-03 QA-A verify)

This commit is contained in:
Aric Camarata 2026-05-30 17:48:48 -04:00
parent 2992dcee21
commit b19d9114ec
38 changed files with 149 additions and 149 deletions

View file

@ -8,7 +8,7 @@
> **downloadKernels**(`config?`): `Promise`\<\{ `leapSecondsPath`: `string`; `planetaryPath`: `string`; \}\> > **downloadKernels**(`config?`): `Promise`\<\{ `leapSecondsPath`: `string`; `planetaryPath`: `string`; \}\>
Defined in: [api/index.ts:159](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L159) Defined in: [api/index.ts:159](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L159)
Download the DE442S planetary kernel and naif0012.tls leap-second kernel Download the DE442S planetary kernel and naif0012.tls leap-second kernel
to the local cache directory. Verifies the download by SHA-256 checksum to the local cache directory. Verifies the download by SHA-256 checksum

View file

@ -8,7 +8,7 @@
> **getMoon**(`date?`, `lat`, `lon`, `elevation?`): [`MoonSnapshot`](../interfaces/MoonSnapshot.md) > **getMoon**(`date?`, `lat`, `lon`, `elevation?`): [`MoonSnapshot`](../interfaces/MoonSnapshot.md)
Defined in: [api/index.ts:727](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L727) Defined in: [api/index.ts:727](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L727)
Combined kernel-free moon snapshot for a time and location. Combined kernel-free moon snapshot for a time and location.

View file

@ -8,7 +8,7 @@
> **getMoonIllumination**(`date?`): [`MoonIlluminationResult`](../interfaces/MoonIlluminationResult.md) > **getMoonIllumination**(`date?`): [`MoonIlluminationResult`](../interfaces/MoonIlluminationResult.md)
Defined in: [api/index.ts:592](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L592) Defined in: [api/index.ts:592](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L592)
Compute the Moon's illumination fraction, phase cycle position, and bright limb angle. Compute the Moon's illumination fraction, phase cycle position, and bright limb angle.

View file

@ -8,7 +8,7 @@
> **getMoonPhase**(`date?`): [`MoonPhaseResult`](../interfaces/MoonPhaseResult.md) > **getMoonPhase**(`date?`): [`MoonPhaseResult`](../interfaces/MoonPhaseResult.md)
Defined in: [api/index.ts:487](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L487) Defined in: [api/index.ts:487](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L487)
Compute the Moon's current phase, illumination, and next phase times. Compute the Moon's current phase, illumination, and next phase times.

View file

@ -8,7 +8,7 @@
> **getMoonPosition**(`date?`, `lat`, `lon`, `elevation?`): [`MoonPosition`](../interfaces/MoonPosition.md) > **getMoonPosition**(`date?`, `lat`, `lon`, `elevation?`): [`MoonPosition`](../interfaces/MoonPosition.md)
Defined in: [api/index.ts:539](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L539) Defined in: [api/index.ts:539](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L539)
Compute the Moon's topocentric position (azimuth, altitude, distance) for an observer. Compute the Moon's topocentric position (azimuth, altitude, distance) for an observer.

View file

@ -8,7 +8,7 @@
> **getMoonSightingReport**(`date`, `observer`, `options?`): `Promise`\<[`MoonSightingReport`](../interfaces/MoonSightingReport.md)\> > **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) Defined in: [api/index.ts:306](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L306)
Compute a complete moon sighting report for a date and location. Compute a complete moon sighting report for a date and location.

View file

@ -8,7 +8,7 @@
> **getMoonVisibilityEstimate**(`date?`, `lat`, `lon`, `elevation?`): [`MoonVisibilityEstimate`](../interfaces/MoonVisibilityEstimate.md) > **getMoonVisibilityEstimate**(`date?`, `lat`, `lon`, `elevation?`): [`MoonVisibilityEstimate`](../interfaces/MoonVisibilityEstimate.md)
Defined in: [api/index.ts:647](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L647) Defined in: [api/index.ts:647](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L647)
Quick kernel-free crescent visibility estimate using the Odeh criterion. Quick kernel-free crescent visibility estimate using the Odeh criterion.

View file

@ -8,7 +8,7 @@
> **getSunMoonEvents**(`date`, `observer`, `options?`): `Promise`\<[`SunMoonEvents`](../interfaces/SunMoonEvents.md)\> > **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) Defined in: [api/index.ts:833](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L833)
Get rise, set, and twilight times for the Sun and Moon on a given date. Get rise, set, and twilight times for the Sun and Moon on a given date.

View file

@ -8,7 +8,7 @@
> **initKernels**(`config?`): `Promise`\<`void`\> > **initKernels**(`config?`): `Promise`\<`void`\>
Defined in: [api/index.ts:121](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L121) Defined in: [api/index.ts:121](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L121)
Initialize the kernel engine from an already-downloaded kernel. Initialize the kernel engine from an already-downloaded kernel.
Must be called before getMoonSightingReport() or getSunMoonEvents(). Must be called before getMoonSightingReport() or getSunMoonEvents().

View file

@ -8,7 +8,7 @@
> **verifyKernels**(`config?`): `Promise`\<\{ `errors`: `string`[]; `ok`: `boolean`; \}\> > **verifyKernels**(`config?`): `Promise`\<\{ `errors`: `string`[]; `ok`: `boolean`; \}\>
Defined in: [api/index.ts:221](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L221) Defined in: [api/index.ts:221](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/api/index.ts#L221)
Verify that locally cached kernels exist (and match checksums if supplied). Verify that locally cached kernels exist (and match checksums if supplied).

View file

@ -6,7 +6,7 @@
# Interface: AzAlt # Interface: AzAlt
Defined in: [types.ts:13](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L13) Defined in: [types.ts:13](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L13)
Azimuth + altitude in degrees Azimuth + altitude in degrees
@ -16,7 +16,7 @@ Azimuth + altitude in degrees
> **altitude**: `number` > **altitude**: `number`
Defined in: [types.ts:17](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L17) Defined in: [types.ts:17](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L17)
Degrees above the horizon (negative = below) Degrees above the horizon (negative = below)
@ -26,6 +26,6 @@ Degrees above the horizon (negative = below)
> **azimuth**: `number` > **azimuth**: `number`
Defined in: [types.ts:15](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L15) Defined in: [types.ts:15](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L15)
Degrees from North, measured clockwise (0 = N, 90 = E, 180 = S, 270 = W) Degrees from North, measured clockwise (0 = N, 90 = E, 180 = S, 270 = W)

View file

@ -6,7 +6,7 @@
# Interface: ChebRecord # Interface: ChebRecord
Defined in: [types.ts:479](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L479) Defined in: [types.ts:479](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L479)
A decoded Chebyshev record from a Type 2 or Type 3 SPK segment A decoded Chebyshev record from a Type 2 or Type 3 SPK segment
@ -16,7 +16,7 @@ A decoded Chebyshev record from a Type 2 or Type 3 SPK segment
> **coeffs**: `Float64Array`\<`ArrayBufferLike`\>[] > **coeffs**: `Float64Array`\<`ArrayBufferLike`\>[]
Defined in: [types.ts:485](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L485) Defined in: [types.ts:485](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L485)
Chebyshev coefficients for X, Y, Z [3][degree+1] Chebyshev coefficients for X, Y, Z [3][degree+1]
@ -26,7 +26,7 @@ Chebyshev coefficients for X, Y, Z [3][degree+1]
> **degree**: `number` > **degree**: `number`
Defined in: [types.ts:487](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L487) Defined in: [types.ts:487](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L487)
Degree of the polynomial Degree of the polynomial
@ -36,7 +36,7 @@ Degree of the polynomial
> **mid**: `number` > **mid**: `number`
Defined in: [types.ts:481](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L481) Defined in: [types.ts:481](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L481)
Midpoint of the record interval in ET seconds past J2000 Midpoint of the record interval in ET seconds past J2000
@ -46,6 +46,6 @@ Midpoint of the record interval in ET seconds past J2000
> **radius**: `number` > **radius**: `number`
Defined in: [types.ts:483](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L483) Defined in: [types.ts:483](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L483)
Half-width of the record interval in seconds Half-width of the record interval in seconds

View file

@ -6,7 +6,7 @@
# Interface: CrescentGeometry # Interface: CrescentGeometry
Defined in: [types.ts:118](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L118) Defined in: [types.ts:118](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L118)
The five geometric quantities used by all major crescent visibility criteria. The five geometric quantities used by all major crescent visibility criteria.
All values computed at best time (T_b) unless noted. All values computed at best time (T_b) unless noted.
@ -17,7 +17,7 @@ All values computed at best time (T_b) unless noted.
> **ARCL**: `number` > **ARCL**: `number`
Defined in: [types.ts:120](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L120) Defined in: [types.ts:120](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L120)
Arc of light: topocentric Sun-Moon angular separation (elongation), degrees Arc of light: topocentric Sun-Moon angular separation (elongation), degrees
@ -27,7 +27,7 @@ Arc of light: topocentric Sun-Moon angular separation (elongation), degrees
> **ARCV**: `number` > **ARCV**: `number`
Defined in: [types.ts:125](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L125) Defined in: [types.ts:125](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L125)
Arc of vision: Moon airless altitude minus Sun airless altitude, degrees. Arc of vision: Moon airless altitude minus Sun airless altitude, degrees.
Used as the primary visibility discriminant in both Yallop and Odeh. Used as the primary visibility discriminant in both Yallop and Odeh.
@ -38,7 +38,7 @@ Used as the primary visibility discriminant in both Yallop and Odeh.
> **DAZ**: `number` > **DAZ**: `number`
Defined in: [types.ts:130](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L130) Defined in: [types.ts:130](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L130)
Relative azimuth: Sun azimuth minus Moon azimuth, normalized to [-180, 180], degrees. Relative azimuth: Sun azimuth minus Moon azimuth, normalized to [-180, 180], degrees.
Positive = Moon north of Sun. Positive = Moon north of Sun.
@ -49,7 +49,7 @@ Positive = Moon north of Sun.
> **lag**: `number` > **lag**: `number`
Defined in: [types.ts:137](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L137) Defined in: [types.ts:137](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L137)
Moonset minus sunset in minutes. Negative = Moon sets before Sun (no sighting possible). Moonset minus sunset in minutes. Negative = Moon sets before Sun (no sighting possible).
@ -59,7 +59,7 @@ Moonset minus sunset in minutes. Negative = Moon sets before Sun (no sighting po
> **W**: `number` > **W**: `number`
Defined in: [types.ts:135](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L135) Defined in: [types.ts:135](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L135)
Topocentric crescent width in arc minutes. Topocentric crescent width in arc minutes.
Used directly in Odeh's polynomial V expression. Used directly in Odeh's polynomial V expression.

View file

@ -6,7 +6,7 @@
# Interface: KernelConfig # Interface: KernelConfig
Defined in: [types.ts:405](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L405) Defined in: [types.ts:405](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L405)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:405](https://github.com/acamarata/moon-sighting/blob/89fb4
> `optional` **cacheDir?**: `string` > `optional` **cacheDir?**: `string`
Defined in: [types.ts:414](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L414) Defined in: [types.ts:414](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L414)
Directory for the download cache. Directory for the download cache.
Defaults to ~/.cache/moon-sighting on POSIX, %LOCALAPPDATA%\moon-sighting on Windows. Defaults to ~/.cache/moon-sighting on POSIX, %LOCALAPPDATA%\moon-sighting on Windows.
@ -25,7 +25,7 @@ Defaults to ~/.cache/moon-sighting on POSIX, %LOCALAPPDATA%\moon-sighting on Win
> `optional` **checksumOverride?**: `string` > `optional` **checksumOverride?**: `string`
Defined in: [types.ts:419](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L419) Defined in: [types.ts:419](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L419)
SHA-256 checksum of de442s.bsp for download verification. SHA-256 checksum of de442s.bsp for download verification.
Bundled default matches the NAIF distribution as of 2024. Bundled default matches the NAIF distribution as of 2024.
@ -36,7 +36,7 @@ Bundled default matches the NAIF distribution as of 2024.
> `optional` **leapSeconds?**: [`KernelSource`](../type-aliases/KernelSource.md) > `optional` **leapSeconds?**: [`KernelSource`](../type-aliases/KernelSource.md)
Defined in: [types.ts:409](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L409) Defined in: [types.ts:409](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L409)
Leap-second kernel — defaults to naif0012.tls via auto-download Leap-second kernel — defaults to naif0012.tls via auto-download
@ -46,6 +46,6 @@ Leap-second kernel — defaults to naif0012.tls via auto-download
> `optional` **planetary?**: [`KernelSource`](../type-aliases/KernelSource.md) > `optional` **planetary?**: [`KernelSource`](../type-aliases/KernelSource.md)
Defined in: [types.ts:407](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L407) Defined in: [types.ts:407](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L407)
Planetary SPK kernel — defaults to de442s.bsp via auto-download Planetary SPK kernel — defaults to de442s.bsp via auto-download

View file

@ -6,7 +6,7 @@
# Interface: MoonIlluminationResult # Interface: MoonIlluminationResult
Defined in: [types.ts:47](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L47) Defined in: [types.ts:47](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L47)
Moon illumination from getMoonIllumination(). Moon illumination from getMoonIllumination().
Computed via Meeus Ch. 47/48 (no kernel required). Computed via Meeus Ch. 47/48 (no kernel required).
@ -18,7 +18,7 @@ Accuracy: fraction ~0.5%, phase fraction ~0.003.
> **angle**: `number` > **angle**: `number`
Defined in: [types.ts:59](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L59) Defined in: [types.ts:59](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L59)
Position angle of the midpoint of the bright limb, measured eastward from Position angle of the midpoint of the bright limb, measured eastward from
the north celestial pole, in radians. Matches the suncalc convention. the north celestial pole, in radians. Matches the suncalc convention.
@ -29,7 +29,7 @@ the north celestial pole, in radians. Matches the suncalc convention.
> **fraction**: `number` > **fraction**: `number`
Defined in: [types.ts:49](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L49) Defined in: [types.ts:49](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L49)
Illuminated fraction of the Moon disk, 0 (new moon) to 1 (full moon) Illuminated fraction of the Moon disk, 0 (new moon) to 1 (full moon)
@ -39,7 +39,7 @@ Illuminated fraction of the Moon disk, 0 (new moon) to 1 (full moon)
> **isWaxing**: `boolean` > **isWaxing**: `boolean`
Defined in: [types.ts:61](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L61) Defined in: [types.ts:61](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L61)
True while elongation is increasing (new moon toward full moon) True while elongation is increasing (new moon toward full moon)
@ -49,7 +49,7 @@ True while elongation is increasing (new moon toward full moon)
> **phase**: `number` > **phase**: `number`
Defined in: [types.ts:54](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L54) Defined in: [types.ts:54](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L54)
Phase cycle fraction in [0, 1): Phase cycle fraction in [0, 1):
0 = new moon, 0.25 = first quarter, 0.5 = full moon, 0.75 = last quarter 0 = new moon, 0.25 = first quarter, 0.5 = full moon, 0.75 = last quarter

View file

@ -6,7 +6,7 @@
# Interface: MoonPhaseResult # Interface: MoonPhaseResult
Defined in: [types.ts:300](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L300) Defined in: [types.ts:300](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L300)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:300](https://github.com/acamarata/moon-sighting/blob/89fb4
> **age**: `number` > **age**: `number`
Defined in: [types.ts:310](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L310) Defined in: [types.ts:310](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L310)
Hours since last new moon Hours since last new moon
@ -24,7 +24,7 @@ Hours since last new moon
> **elongationDeg**: `number` > **elongationDeg**: `number`
Defined in: [types.ts:312](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L312) Defined in: [types.ts:312](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L312)
Ecliptic longitude of the Moon minus the Sun, degrees [0, 360) Ecliptic longitude of the Moon minus the Sun, degrees [0, 360)
@ -34,7 +34,7 @@ Ecliptic longitude of the Moon minus the Sun, degrees [0, 360)
> **illumination**: `number` > **illumination**: `number`
Defined in: [types.ts:308](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L308) Defined in: [types.ts:308](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L308)
Illuminated fraction 0-100 (percent) Illuminated fraction 0-100 (percent)
@ -44,7 +44,7 @@ Illuminated fraction 0-100 (percent)
> **isWaxing**: `boolean` > **isWaxing**: `boolean`
Defined in: [types.ts:314](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L314) Defined in: [types.ts:314](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L314)
True when Moon is moving away from the Sun (illumination increasing) True when Moon is moving away from the Sun (illumination increasing)
@ -54,7 +54,7 @@ True when Moon is moving away from the Sun (illumination increasing)
> **nextFullMoon**: `Date` > **nextFullMoon**: `Date`
Defined in: [types.ts:318](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L318) Defined in: [types.ts:318](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L318)
UTC date of the next full moon UTC date of the next full moon
@ -64,7 +64,7 @@ UTC date of the next full moon
> **nextNewMoon**: `Date` > **nextNewMoon**: `Date`
Defined in: [types.ts:316](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L316) Defined in: [types.ts:316](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L316)
UTC date of the next new moon UTC date of the next new moon
@ -74,7 +74,7 @@ UTC date of the next new moon
> **phase**: [`MoonPhaseName`](../type-aliases/MoonPhaseName.md) > **phase**: [`MoonPhaseName`](../type-aliases/MoonPhaseName.md)
Defined in: [types.ts:302](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L302) Defined in: [types.ts:302](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L302)
Named phase based on illumination and waxing/waning state Named phase based on illumination and waxing/waning state
@ -84,7 +84,7 @@ Named phase based on illumination and waxing/waning state
> **phaseName**: `string` > **phaseName**: `string`
Defined in: [types.ts:304](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L304) Defined in: [types.ts:304](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L304)
Human-readable phase name, e.g. "Waxing Crescent" Human-readable phase name, e.g. "Waxing Crescent"
@ -94,7 +94,7 @@ Human-readable phase name, e.g. "Waxing Crescent"
> **phaseSymbol**: `string` > **phaseSymbol**: `string`
Defined in: [types.ts:306](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L306) Defined in: [types.ts:306](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L306)
Moon phase emoji symbol, e.g. "🌒" Moon phase emoji symbol, e.g. "🌒"
@ -104,6 +104,6 @@ Moon phase emoji symbol, e.g. "🌒"
> **prevNewMoon**: `Date` > **prevNewMoon**: `Date`
Defined in: [types.ts:320](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L320) Defined in: [types.ts:320](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L320)
UTC date of the previous new moon UTC date of the previous new moon

View file

@ -6,7 +6,7 @@
# Interface: MoonPosition # Interface: MoonPosition
Defined in: [types.ts:27](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L27) Defined in: [types.ts:27](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L27)
Topocentric moon position from getMoonPosition(). Topocentric moon position from getMoonPosition().
Computed via Meeus Ch. 47 (no kernel required). Computed via Meeus Ch. 47 (no kernel required).
@ -18,7 +18,7 @@ Accuracy: azimuth/altitude ~0.3°, distance ~300 km.
> **altitude**: `number` > **altitude**: `number`
Defined in: [types.ts:31](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L31) Defined in: [types.ts:31](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L31)
Apparent altitude in degrees above the horizon (atmospheric refraction applied) Apparent altitude in degrees above the horizon (atmospheric refraction applied)
@ -28,7 +28,7 @@ Apparent altitude in degrees above the horizon (atmospheric refraction applied)
> **azimuth**: `number` > **azimuth**: `number`
Defined in: [types.ts:29](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L29) Defined in: [types.ts:29](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L29)
Azimuth in degrees from North, measured clockwise (0 = N, 90 = E, 180 = S, 270 = W) Azimuth in degrees from North, measured clockwise (0 = N, 90 = E, 180 = S, 270 = W)
@ -38,7 +38,7 @@ Azimuth in degrees from North, measured clockwise (0 = N, 90 = E, 180 = S, 270 =
> **distance**: `number` > **distance**: `number`
Defined in: [types.ts:33](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L33) Defined in: [types.ts:33](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L33)
Distance from Earth center to Moon center, km Distance from Earth center to Moon center, km
@ -48,7 +48,7 @@ Distance from Earth center to Moon center, km
> **parallacticAngle**: `number` > **parallacticAngle**: `number`
Defined in: [types.ts:39](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L39) Defined in: [types.ts:39](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L39)
Parallactic angle in radians. Parallactic angle in radians.
The angle between the great circle through the Moon and zenith, and the great circle The angle between the great circle through the Moon and zenith, and the great circle

View file

@ -6,7 +6,7 @@
# Interface: MoonSightingReport # Interface: MoonSightingReport
Defined in: [types.ts:344](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L344) Defined in: [types.ts:344](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L344)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:344](https://github.com/acamarata/moon-sighting/blob/89fb4
> **bestTimeUTC**: `Date` \| `null` > **bestTimeUTC**: `Date` \| `null`
Defined in: [types.ts:356](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L356) Defined in: [types.ts:356](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L356)
Best observation time (Odeh/Yallop: T_s + 4/9 * Lag) Best observation time (Odeh/Yallop: T_s + 4/9 * Lag)
@ -24,7 +24,7 @@ Best observation time (Odeh/Yallop: T_s + 4/9 * Lag)
> **bestTimeWindowUTC**: \[`Date`, `Date`\] \| `null` > **bestTimeWindowUTC**: \[`Date`, `Date`\] \| `null`
Defined in: [types.ts:358](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L358) Defined in: [types.ts:358](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L358)
Conservative observation window [bestTime - 20min, bestTime + 20min] Conservative observation window [bestTime - 20min, bestTime + 20min]
@ -34,7 +34,7 @@ Conservative observation window [bestTime - 20min, bestTime + 20min]
> **date**: `Date` > **date**: `Date`
Defined in: [types.ts:346](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L346) Defined in: [types.ts:346](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L346)
Date for which the sighting report was computed Date for which the sighting report was computed
@ -44,7 +44,7 @@ Date for which the sighting report was computed
> **ephemerisSource**: `"DE442S"` \| `"approximate"` > **ephemerisSource**: `"DE442S"` \| `"approximate"`
Defined in: [types.ts:386](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L386) Defined in: [types.ts:386](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L386)
Source ephemeris used for this calculation Source ephemeris used for this calculation
@ -54,7 +54,7 @@ Source ephemeris used for this calculation
> **geometry**: [`CrescentGeometry`](CrescentGeometry.md) \| `null` > **geometry**: [`CrescentGeometry`](CrescentGeometry.md) \| `null`
Defined in: [types.ts:371](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L371) Defined in: [types.ts:371](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L371)
*** ***
@ -62,7 +62,7 @@ Defined in: [types.ts:371](https://github.com/acamarata/moon-sighting/blob/89fb4
> **guidance**: `string` > **guidance**: `string`
Defined in: [types.ts:382](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L382) Defined in: [types.ts:382](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L382)
Plain-language direction for observers. Plain-language direction for observers.
Includes where to look (azimuth, altitude), when (best time), and what to expect. Includes where to look (azimuth, altitude), when (best time), and what to expect.
@ -73,7 +73,7 @@ Includes where to look (azimuth, altitude), when (best time), and what to expect
> **illumination**: `number` \| `null` > **illumination**: `number` \| `null`
Defined in: [types.ts:366](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L366) Defined in: [types.ts:366](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L366)
Moon illumination percent at best time Moon illumination percent at best time
@ -83,7 +83,7 @@ Moon illumination percent at best time
> **lagMinutes**: `number` \| `null` > **lagMinutes**: `number` \| `null`
Defined in: [types.ts:354](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L354) Defined in: [types.ts:354](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L354)
Moonset minus sunset, in minutes. Null if either event is null. Moonset minus sunset, in minutes. Null if either event is null.
@ -93,7 +93,7 @@ Moonset minus sunset, in minutes. Null if either event is null.
> **moonAboveHorizon**: `boolean` \| `null` > **moonAboveHorizon**: `boolean` \| `null`
Defined in: [types.ts:388](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L388) Defined in: [types.ts:388](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L388)
Whether the Moon is even above the horizon at best time Whether the Moon is even above the horizon at best time
@ -103,7 +103,7 @@ Whether the Moon is even above the horizon at best time
> **moonAge**: `number` \| `null` > **moonAge**: `number` \| `null`
Defined in: [types.ts:368](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L368) Defined in: [types.ts:368](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L368)
Hours since conjunction (new moon) Hours since conjunction (new moon)
@ -113,7 +113,7 @@ Hours since conjunction (new moon)
> **moonPosition**: [`AzAlt`](AzAlt.md) \| `null` > **moonPosition**: [`AzAlt`](AzAlt.md) \| `null`
Defined in: [types.ts:362](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L362) Defined in: [types.ts:362](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L362)
Topocentric Moon position at best time Topocentric Moon position at best time
@ -123,7 +123,7 @@ Topocentric Moon position at best time
> **moonsetUTC**: `Date` \| `null` > **moonsetUTC**: `Date` \| `null`
Defined in: [types.ts:352](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L352) Defined in: [types.ts:352](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L352)
*** ***
@ -131,7 +131,7 @@ Defined in: [types.ts:352](https://github.com/acamarata/moon-sighting/blob/89fb4
> **observer**: [`Observer`](Observer.md) > **observer**: [`Observer`](Observer.md)
Defined in: [types.ts:348](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L348) Defined in: [types.ts:348](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L348)
Observer location used Observer location used
@ -141,7 +141,7 @@ Observer location used
> **odeh**: [`OdehResult`](OdehResult.md) \| `null` > **odeh**: [`OdehResult`](OdehResult.md) \| `null`
Defined in: [types.ts:375](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L375) Defined in: [types.ts:375](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L375)
*** ***
@ -149,7 +149,7 @@ Defined in: [types.ts:375](https://github.com/acamarata/moon-sighting/blob/89fb4
> **sightingPossible**: `boolean` > **sightingPossible**: `boolean`
Defined in: [types.ts:390](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L390) Defined in: [types.ts:390](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L390)
Whether sighting is geometrically possible (lag > 0, Moon above horizon at best time) Whether sighting is geometrically possible (lag > 0, Moon above horizon at best time)
@ -159,7 +159,7 @@ Whether sighting is geometrically possible (lag > 0, Moon above horizon at best
> **sunPosition**: [`AzAlt`](AzAlt.md) \| `null` > **sunPosition**: [`AzAlt`](AzAlt.md) \| `null`
Defined in: [types.ts:364](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L364) Defined in: [types.ts:364](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L364)
Topocentric Sun position at best time Topocentric Sun position at best time
@ -169,7 +169,7 @@ Topocentric Sun position at best time
> **sunsetUTC**: `Date` \| `null` > **sunsetUTC**: `Date` \| `null`
Defined in: [types.ts:351](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L351) Defined in: [types.ts:351](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L351)
*** ***
@ -177,4 +177,4 @@ Defined in: [types.ts:351](https://github.com/acamarata/moon-sighting/blob/89fb4
> **yallop**: [`YallopResult`](YallopResult.md) \| `null` > **yallop**: [`YallopResult`](YallopResult.md) \| `null`
Defined in: [types.ts:374](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L374) Defined in: [types.ts:374](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L374)

View file

@ -6,7 +6,7 @@
# Interface: MoonSnapshot # Interface: MoonSnapshot
Defined in: [types.ts:277](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L277) Defined in: [types.ts:277](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L277)
Combined kernel-free moon snapshot from getMoon(). Combined kernel-free moon snapshot from getMoon().
Bundles phase, position, illumination, and a quick visibility estimate Bundles phase, position, illumination, and a quick visibility estimate
@ -18,7 +18,7 @@ into a single call.
> **illumination**: [`MoonIlluminationResult`](MoonIlluminationResult.md) > **illumination**: [`MoonIlluminationResult`](MoonIlluminationResult.md)
Defined in: [types.ts:283](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L283) Defined in: [types.ts:283](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L283)
Illumination fraction, phase cycle, bright limb angle, waxing/waning Illumination fraction, phase cycle, bright limb angle, waxing/waning
@ -28,7 +28,7 @@ Illumination fraction, phase cycle, bright limb angle, waxing/waning
> **phase**: [`MoonPhaseResult`](MoonPhaseResult.md) > **phase**: [`MoonPhaseResult`](MoonPhaseResult.md)
Defined in: [types.ts:279](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L279) Defined in: [types.ts:279](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L279)
Phase name, illumination, age, and next events Phase name, illumination, age, and next events
@ -38,7 +38,7 @@ Phase name, illumination, age, and next events
> **position**: [`MoonPosition`](MoonPosition.md) > **position**: [`MoonPosition`](MoonPosition.md)
Defined in: [types.ts:281](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L281) Defined in: [types.ts:281](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L281)
Topocentric az/alt, distance, parallactic angle Topocentric az/alt, distance, parallactic angle
@ -48,6 +48,6 @@ Topocentric az/alt, distance, parallactic angle
> **visibility**: [`MoonVisibilityEstimate`](MoonVisibilityEstimate.md) > **visibility**: [`MoonVisibilityEstimate`](MoonVisibilityEstimate.md)
Defined in: [types.ts:285](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L285) Defined in: [types.ts:285](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L285)
Quick Odeh-based crescent visibility estimate Quick Odeh-based crescent visibility estimate

View file

@ -6,7 +6,7 @@
# Interface: MoonVisibilityEstimate # Interface: MoonVisibilityEstimate
Defined in: [types.ts:246](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L246) Defined in: [types.ts:246](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L246)
Kernel-free Odeh-based crescent visibility estimate from getMoonVisibilityEstimate(). Kernel-free Odeh-based crescent visibility estimate from getMoonVisibilityEstimate().
Computed via Meeus Ch. 47 approximation at the given observation time. Computed via Meeus Ch. 47 approximation at the given observation time.
@ -18,7 +18,7 @@ For DE442S-quality results, use getMoonSightingReport().
> **ARCL**: `number` > **ARCL**: `number`
Defined in: [types.ts:261](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L261) Defined in: [types.ts:261](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L261)
Arc of light (Sun-Moon elongation) in degrees Arc of light (Sun-Moon elongation) in degrees
@ -28,7 +28,7 @@ Arc of light (Sun-Moon elongation) in degrees
> **ARCV**: `number` > **ARCV**: `number`
Defined in: [types.ts:263](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L263) Defined in: [types.ts:263](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L263)
Arc of vision (Moon airless altitude minus Sun airless altitude) in degrees Arc of vision (Moon airless altitude minus Sun airless altitude) in degrees
@ -38,7 +38,7 @@ Arc of vision (Moon airless altitude minus Sun airless altitude) in degrees
> **description**: `string` > **description**: `string`
Defined in: [types.ts:255](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L255) Defined in: [types.ts:255](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L255)
Human-readable zone description Human-readable zone description
@ -48,7 +48,7 @@ Human-readable zone description
> **isApproximate**: `true` > **isApproximate**: `true`
Defined in: [types.ts:269](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L269) Defined in: [types.ts:269](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L269)
Always true: computed via Meeus approximation, not DE442S Always true: computed via Meeus approximation, not DE442S
@ -58,7 +58,7 @@ Always true: computed via Meeus approximation, not DE442S
> **isVisibleNakedEye**: `boolean` > **isVisibleNakedEye**: `boolean`
Defined in: [types.ts:257](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L257) Defined in: [types.ts:257](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L257)
True for zone A True for zone A
@ -68,7 +68,7 @@ True for zone A
> **isVisibleWithOpticalAid**: `boolean` > **isVisibleWithOpticalAid**: `boolean`
Defined in: [types.ts:259](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L259) Defined in: [types.ts:259](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L259)
True for zones A and B True for zones A and B
@ -78,7 +78,7 @@ True for zones A and B
> **moonAboveHorizon**: `boolean` > **moonAboveHorizon**: `boolean`
Defined in: [types.ts:267](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L267) Defined in: [types.ts:267](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L267)
True when Moon is above the horizon at the given time True when Moon is above the horizon at the given time
@ -88,7 +88,7 @@ True when Moon is above the horizon at the given time
> **V**: `number` > **V**: `number`
Defined in: [types.ts:251](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L251) Defined in: [types.ts:251](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L251)
Odeh V parameter: V = ARCV f(W). Odeh V parameter: V = ARCV f(W).
Positive = crescent exceeds minimum visibility threshold. Positive = crescent exceeds minimum visibility threshold.
@ -99,7 +99,7 @@ Positive = crescent exceeds minimum visibility threshold.
> **W**: `number` > **W**: `number`
Defined in: [types.ts:265](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L265) Defined in: [types.ts:265](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L265)
Topocentric crescent width in arc minutes Topocentric crescent width in arc minutes
@ -109,6 +109,6 @@ Topocentric crescent width in arc minutes
> **zone**: [`OdehZone`](../type-aliases/OdehZone.md) > **zone**: [`OdehZone`](../type-aliases/OdehZone.md)
Defined in: [types.ts:253](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L253) Defined in: [types.ts:253](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L253)
Visibility zone A through D Visibility zone A through D

View file

@ -6,7 +6,7 @@
# Interface: Observer # Interface: Observer
Defined in: [types.ts:86](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L86) Defined in: [types.ts:86](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L86)
Observer location and environmental parameters Observer location and environmental parameters
@ -16,7 +16,7 @@ Observer location and environmental parameters
> `optional` **deltaT?**: `number` > `optional` **deltaT?**: `number`
Defined in: [types.ts:100](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L100) Defined in: [types.ts:100](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L100)
Override TT - UT1 in seconds. Override TT - UT1 in seconds.
When provided, used directly. Otherwise the built-in polynomial is used. When provided, used directly. Otherwise the built-in polynomial is used.
@ -28,7 +28,7 @@ For maximum accuracy, supply the current IERS value (typically within ±0.9s).
> **elevation**: `number` > **elevation**: `number`
Defined in: [types.ts:92](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L92) Defined in: [types.ts:92](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L92)
Height above WGS84 ellipsoid in meters Height above WGS84 ellipsoid in meters
@ -38,7 +38,7 @@ Height above WGS84 ellipsoid in meters
> **lat**: `number` > **lat**: `number`
Defined in: [types.ts:88](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L88) Defined in: [types.ts:88](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L88)
Geodetic latitude in degrees (north positive) Geodetic latitude in degrees (north positive)
@ -48,7 +48,7 @@ Geodetic latitude in degrees (north positive)
> **lon**: `number` > **lon**: `number`
Defined in: [types.ts:90](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L90) Defined in: [types.ts:90](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L90)
Longitude in degrees (east positive) Longitude in degrees (east positive)
@ -58,7 +58,7 @@ Longitude in degrees (east positive)
> `optional` **name?**: `string` > `optional` **name?**: `string`
Defined in: [types.ts:94](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L94) Defined in: [types.ts:94](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L94)
Optional label for the location Optional label for the location
@ -68,7 +68,7 @@ Optional label for the location
> `optional` **pressure?**: `number` > `optional` **pressure?**: `number`
Defined in: [types.ts:107](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L107) Defined in: [types.ts:107](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L107)
Atmospheric pressure in millibars (default 1013.25) Atmospheric pressure in millibars (default 1013.25)
@ -78,7 +78,7 @@ Atmospheric pressure in millibars (default 1013.25)
> `optional` **temperature?**: `number` > `optional` **temperature?**: `number`
Defined in: [types.ts:109](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L109) Defined in: [types.ts:109](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L109)
Ambient temperature in Celsius (default 15) Ambient temperature in Celsius (default 15)
@ -88,7 +88,7 @@ Ambient temperature in Celsius (default 15)
> `optional` **ut1utc?**: `number` > `optional` **ut1utc?**: `number`
Defined in: [types.ts:105](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L105) Defined in: [types.ts:105](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L105)
Override UT1 - UTC in seconds (from IERS Bulletin A). Override UT1 - UTC in seconds (from IERS Bulletin A).
Takes precedence over deltaT when both are provided. Takes precedence over deltaT when both are provided.

View file

@ -6,7 +6,7 @@
# Interface: OdehResult # Interface: OdehResult
Defined in: [types.ts:223](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L223) Defined in: [types.ts:223](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L223)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:223](https://github.com/acamarata/moon-sighting/blob/89fb4
> **description**: `string` > **description**: `string`
Defined in: [types.ts:232](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L232) Defined in: [types.ts:232](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L232)
Human-readable interpretation Human-readable interpretation
@ -24,7 +24,7 @@ Human-readable interpretation
> **isVisibleNakedEye**: `boolean` > **isVisibleNakedEye**: `boolean`
Defined in: [types.ts:234](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L234) Defined in: [types.ts:234](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L234)
True for zone A True for zone A
@ -34,7 +34,7 @@ True for zone A
> **isVisibleWithOpticalAid**: `boolean` > **isVisibleWithOpticalAid**: `boolean`
Defined in: [types.ts:236](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L236) Defined in: [types.ts:236](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L236)
True for zones A and B True for zones A and B
@ -44,7 +44,7 @@ True for zones A and B
> **V**: `number` > **V**: `number`
Defined in: [types.ts:228](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L228) Defined in: [types.ts:228](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L228)
Continuous visibility parameter V = ARCV - (arcv_minimum(W)). Continuous visibility parameter V = ARCV - (arcv_minimum(W)).
Positive = crescent exceeds minimum visibility threshold. Positive = crescent exceeds minimum visibility threshold.
@ -55,6 +55,6 @@ Positive = crescent exceeds minimum visibility threshold.
> **zone**: [`OdehZone`](../type-aliases/OdehZone.md) > **zone**: [`OdehZone`](../type-aliases/OdehZone.md)
Defined in: [types.ts:230](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L230) Defined in: [types.ts:230](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L230)
Visibility zone A through D Visibility zone A through D

View file

@ -6,7 +6,7 @@
# Interface: SightingOptions # Interface: SightingOptions
Defined in: [types.ts:424](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L424) Defined in: [types.ts:424](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L424)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:424](https://github.com/acamarata/moon-sighting/blob/89fb4
> `optional` **bestTimeMethod?**: `"heuristic"` \| `"optimized"` > `optional` **bestTimeMethod?**: `"heuristic"` \| `"optimized"`
Defined in: [types.ts:433](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L433) Defined in: [types.ts:433](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L433)
Best-time computation method. Best-time computation method.
'heuristic' — T_b = T_sunset + 4/9 * Lag (Odeh/Yallop approximation, fast) 'heuristic' — T_b = T_sunset + 4/9 * Lag (Odeh/Yallop approximation, fast)
@ -27,6 +27,6 @@ Default: 'heuristic'
> `optional` **kernels?**: [`KernelConfig`](KernelConfig.md) > `optional` **kernels?**: [`KernelConfig`](KernelConfig.md)
Defined in: [types.ts:426](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L426) Defined in: [types.ts:426](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L426)
Kernel acquisition configuration. Defaults to auto-download. Kernel acquisition configuration. Defaults to auto-download.

View file

@ -6,7 +6,7 @@
# Interface: SpkSegment # Interface: SpkSegment
Defined in: [types.ts:459](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L459) Defined in: [types.ts:459](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L459)
A segment in a JPL SPK (DAF) kernel file A segment in a JPL SPK (DAF) kernel file
@ -16,7 +16,7 @@ A segment in a JPL SPK (DAF) kernel file
> **center**: `number` > **center**: `number`
Defined in: [types.ts:463](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L463) Defined in: [types.ts:463](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L463)
NAIF body ID of the center body NAIF body ID of the center body
@ -26,7 +26,7 @@ NAIF body ID of the center body
> **dataOffset**: `number` > **dataOffset**: `number`
Defined in: [types.ts:473](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L473) Defined in: [types.ts:473](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L473)
Byte offset of the data array in the file Byte offset of the data array in the file
@ -36,7 +36,7 @@ Byte offset of the data array in the file
> **dataSize**: `number` > **dataSize**: `number`
Defined in: [types.ts:475](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L475) Defined in: [types.ts:475](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L475)
Number of double-precision values in the data array Number of double-precision values in the data array
@ -46,7 +46,7 @@ Number of double-precision values in the data array
> **dataType**: `2` \| `3` > **dataType**: `2` \| `3`
Defined in: [types.ts:467](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L467) Defined in: [types.ts:467](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L467)
SPK data type (2 = Chebyshev position only, 3 = Chebyshev position + velocity) SPK data type (2 = Chebyshev position only, 3 = Chebyshev position + velocity)
@ -56,7 +56,7 @@ SPK data type (2 = Chebyshev position only, 3 = Chebyshev position + velocity)
> **endET**: `number` > **endET**: `number`
Defined in: [types.ts:471](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L471) Defined in: [types.ts:471](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L471)
Segment end time in ET seconds past J2000 Segment end time in ET seconds past J2000
@ -66,7 +66,7 @@ Segment end time in ET seconds past J2000
> **frame**: `number` > **frame**: `number`
Defined in: [types.ts:465](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L465) Defined in: [types.ts:465](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L465)
Reference frame code Reference frame code
@ -76,7 +76,7 @@ Reference frame code
> **startET**: `number` > **startET**: `number`
Defined in: [types.ts:469](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L469) Defined in: [types.ts:469](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L469)
Segment start time in ET seconds past J2000 Segment start time in ET seconds past J2000
@ -86,6 +86,6 @@ Segment start time in ET seconds past J2000
> **target**: `number` > **target**: `number`
Defined in: [types.ts:461](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L461) Defined in: [types.ts:461](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L461)
NAIF body ID of the target body NAIF body ID of the target body

View file

@ -6,7 +6,7 @@
# Interface: StateVector # Interface: StateVector
Defined in: [types.ts:7](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L7) Defined in: [types.ts:7](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L7)
Position + velocity state vector from the ephemeris Position + velocity state vector from the ephemeris
@ -16,7 +16,7 @@ Position + velocity state vector from the ephemeris
> **position**: [`Vec3`](../type-aliases/Vec3.md) > **position**: [`Vec3`](../type-aliases/Vec3.md)
Defined in: [types.ts:8](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L8) Defined in: [types.ts:8](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L8)
*** ***
@ -24,4 +24,4 @@ Defined in: [types.ts:8](https://github.com/acamarata/moon-sighting/blob/89fb490
> **velocity**: [`Vec3`](../type-aliases/Vec3.md) > **velocity**: [`Vec3`](../type-aliases/Vec3.md)
Defined in: [types.ts:9](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L9) Defined in: [types.ts:9](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L9)

View file

@ -6,7 +6,7 @@
# Interface: SunMoonEvents # Interface: SunMoonEvents
Defined in: [types.ts:325](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L325) Defined in: [types.ts:325](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L325)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:325](https://github.com/acamarata/moon-sighting/blob/89fb4
> **astronomicalTwilightEndUTC**: `Date` \| `null` > **astronomicalTwilightEndUTC**: `Date` \| `null`
Defined in: [types.ts:339](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L339) Defined in: [types.ts:339](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L339)
UTC time when astronomical twilight ends (Sun at -18°) UTC time when astronomical twilight ends (Sun at -18°)
@ -24,7 +24,7 @@ UTC time when astronomical twilight ends (Sun at -18°)
> **civilTwilightEndUTC**: `Date` \| `null` > **civilTwilightEndUTC**: `Date` \| `null`
Defined in: [types.ts:335](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L335) Defined in: [types.ts:335](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L335)
UTC time when civil twilight ends (Sun at -6°) UTC time when civil twilight ends (Sun at -6°)
@ -34,7 +34,7 @@ UTC time when civil twilight ends (Sun at -6°)
> **moonriseUTC**: `Date` \| `null` > **moonriseUTC**: `Date` \| `null`
Defined in: [types.ts:333](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L333) Defined in: [types.ts:333](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L333)
UTC time of moonrise UTC time of moonrise
@ -44,7 +44,7 @@ UTC time of moonrise
> **moonsetUTC**: `Date` \| `null` > **moonsetUTC**: `Date` \| `null`
Defined in: [types.ts:329](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L329) Defined in: [types.ts:329](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L329)
UTC time of moonset for the given date at the observer's location UTC time of moonset for the given date at the observer's location
@ -54,7 +54,7 @@ UTC time of moonset for the given date at the observer's location
> **nauticalTwilightEndUTC**: `Date` \| `null` > **nauticalTwilightEndUTC**: `Date` \| `null`
Defined in: [types.ts:337](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L337) Defined in: [types.ts:337](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L337)
UTC time when nautical twilight ends (Sun at -12°) UTC time when nautical twilight ends (Sun at -12°)
@ -64,7 +64,7 @@ UTC time when nautical twilight ends (Sun at -12°)
> **sunriseUTC**: `Date` \| `null` > **sunriseUTC**: `Date` \| `null`
Defined in: [types.ts:331](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L331) Defined in: [types.ts:331](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L331)
UTC time of sunrise UTC time of sunrise
@ -74,6 +74,6 @@ UTC time of sunrise
> **sunsetUTC**: `Date` \| `null` > **sunsetUTC**: `Date` \| `null`
Defined in: [types.ts:327](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L327) Defined in: [types.ts:327](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L327)
UTC time of sunset for the given date at the observer's location UTC time of sunset for the given date at the observer's location

View file

@ -6,7 +6,7 @@
# Interface: TimeScales # Interface: TimeScales
Defined in: [types.ts:67](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L67) Defined in: [types.ts:67](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L67)
All relevant time scale values for a single moment All relevant time scale values for a single moment
@ -16,7 +16,7 @@ All relevant time scale values for a single moment
> **deltaAT**: `number` > **deltaAT**: `number`
Defined in: [types.ts:80](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L80) Defined in: [types.ts:80](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L80)
TAI - UTC in seconds (leap seconds count) TAI - UTC in seconds (leap seconds count)
@ -26,7 +26,7 @@ TAI - UTC in seconds (leap seconds count)
> **deltaT**: `number` > **deltaT**: `number`
Defined in: [types.ts:78](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L78) Defined in: [types.ts:78](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L78)
TT - UT1 in seconds (delta-T) TT - UT1 in seconds (delta-T)
@ -36,7 +36,7 @@ TT - UT1 in seconds (delta-T)
> **jdTDB**: `number` > **jdTDB**: `number`
Defined in: [types.ts:74](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L74) Defined in: [types.ts:74](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L74)
Julian Date in Barycentric Dynamical Time (used by JPL ephemerides) Julian Date in Barycentric Dynamical Time (used by JPL ephemerides)
@ -46,7 +46,7 @@ Julian Date in Barycentric Dynamical Time (used by JPL ephemerides)
> **jdTT**: `number` > **jdTT**: `number`
Defined in: [types.ts:72](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L72) Defined in: [types.ts:72](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L72)
Julian Date in Terrestrial Time (TT = TAI + 32.184s) Julian Date in Terrestrial Time (TT = TAI + 32.184s)
@ -56,7 +56,7 @@ Julian Date in Terrestrial Time (TT = TAI + 32.184s)
> **jdUT1**: `number` > **jdUT1**: `number`
Defined in: [types.ts:76](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L76) Defined in: [types.ts:76](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L76)
Julian Date in UT1 (Earth rotation time) Julian Date in UT1 (Earth rotation time)
@ -66,7 +66,7 @@ Julian Date in UT1 (Earth rotation time)
> **jdUTC**: `number` > **jdUTC**: `number`
Defined in: [types.ts:70](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L70) Defined in: [types.ts:70](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L70)
Julian Date in UTC Julian Date in UTC
@ -76,4 +76,4 @@ Julian Date in UTC
> **utc**: `Date` > **utc**: `Date`
Defined in: [types.ts:68](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L68) Defined in: [types.ts:68](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L68)

View file

@ -6,7 +6,7 @@
# Interface: YallopResult # Interface: YallopResult
Defined in: [types.ts:176](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L176) Defined in: [types.ts:176](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L176)
## Properties ## Properties
@ -14,7 +14,7 @@ Defined in: [types.ts:176](https://github.com/acamarata/moon-sighting/blob/89fb4
> **category**: [`YallopCategory`](../type-aliases/YallopCategory.md) > **category**: [`YallopCategory`](../type-aliases/YallopCategory.md)
Defined in: [types.ts:180](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L180) Defined in: [types.ts:180](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L180)
Visibility category A through F Visibility category A through F
@ -24,7 +24,7 @@ Visibility category A through F
> **description**: `string` > **description**: `string`
Defined in: [types.ts:182](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L182) Defined in: [types.ts:182](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L182)
Human-readable interpretation Human-readable interpretation
@ -34,7 +34,7 @@ Human-readable interpretation
> **isBelowDanjonLimit**: `boolean` > **isBelowDanjonLimit**: `boolean`
Defined in: [types.ts:188](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L188) Defined in: [types.ts:188](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L188)
True for category F True for category F
@ -44,7 +44,7 @@ True for category F
> **isVisibleNakedEye**: `boolean` > **isVisibleNakedEye**: `boolean`
Defined in: [types.ts:184](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L184) Defined in: [types.ts:184](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L184)
True for categories A and B True for categories A and B
@ -54,7 +54,7 @@ True for categories A and B
> **q**: `number` > **q**: `number`
Defined in: [types.ts:178](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L178) Defined in: [types.ts:178](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L178)
The continuous q parameter (higher = more visible) The continuous q parameter (higher = more visible)
@ -64,7 +64,7 @@ The continuous q parameter (higher = more visible)
> **requiresOpticalAid**: `boolean` > **requiresOpticalAid**: `boolean`
Defined in: [types.ts:186](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L186) Defined in: [types.ts:186](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L186)
True for categories C and D True for categories C and D
@ -74,6 +74,6 @@ True for categories C and D
> **Wprime**: `number` > **Wprime**: `number`
Defined in: [types.ts:190](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L190) Defined in: [types.ts:190](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L190)
Topocentric crescent width W' used in the q formula, arc minutes Topocentric crescent width W' used in the q formula, arc minutes

View file

@ -8,7 +8,7 @@
> **KernelSource** = \{ `path`: `string`; `type`: `"file"`; \} \| \{ `data`: `ArrayBuffer`; `name`: `string`; `type`: `"buffer"`; \} \| \{ `type`: `"url"`; `url`: `string`; \} \| \{ `type`: `"auto"`; \} > **KernelSource** = \{ `path`: `string`; `type`: `"file"`; \} \| \{ `data`: `ArrayBuffer`; `name`: `string`; `type`: `"buffer"`; \} \| \{ `type`: `"url"`; `url`: `string`; \} \| \{ `type`: `"auto"`; \}
Defined in: [types.ts:399](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L399) Defined in: [types.ts:399](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L399)
How to source a binary kernel file. How to source a binary kernel file.
Used for both the planetary SPK (de442s.bsp) and leap-second kernel (naif0012.tls). Used for both the planetary SPK (de442s.bsp) and leap-second kernel (naif0012.tls).

View file

@ -8,4 +8,4 @@
> **MoonPhaseName** = `"new-moon"` \| `"waxing-crescent"` \| `"first-quarter"` \| `"waxing-gibbous"` \| `"full-moon"` \| `"waning-gibbous"` \| `"last-quarter"` \| `"waning-crescent"` > **MoonPhaseName** = `"new-moon"` \| `"waxing-crescent"` \| `"first-quarter"` \| `"waxing-gibbous"` \| `"full-moon"` \| `"waning-gibbous"` \| `"last-quarter"` \| `"waning-crescent"`
Defined in: [types.ts:290](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L290) Defined in: [types.ts:290](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L290)

View file

@ -8,6 +8,6 @@
> **OdehZone** = `"A"` \| `"B"` \| `"C"` \| `"D"` > **OdehZone** = `"A"` \| `"B"` \| `"C"` \| `"D"`
Defined in: [types.ts:197](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L197) Defined in: [types.ts:197](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L197)
Odeh visibility zone (A = naked eye visible, D = not visible with any aid). Odeh visibility zone (A = naked eye visible, D = not visible with any aid).

View file

@ -8,6 +8,6 @@
> **Vec3** = \[`number`, `number`, `number`\] > **Vec3** = \[`number`, `number`, `number`\]
Defined in: [types.ts:4](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L4) Defined in: [types.ts:4](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L4)
3-element position or velocity vector in km or km/s 3-element position or velocity vector in km or km/s

View file

@ -8,6 +8,6 @@
> **YallopCategory** = `"A"` \| `"B"` \| `"C"` \| `"D"` \| `"E"` \| `"F"` > **YallopCategory** = `"A"` \| `"B"` \| `"C"` \| `"D"` \| `"E"` \| `"F"`
Defined in: [types.ts:144](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L144) Defined in: [types.ts:144](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L144)
Yallop visibility category (A = easily visible, F = below Danjon limit). Yallop visibility category (A = easily visible, F = below Danjon limit).

View file

@ -8,7 +8,7 @@
> `const` **ODEH\_DESCRIPTIONS**: `Record`\<[`OdehZone`](../type-aliases/OdehZone.md), `string`\> > `const` **ODEH\_DESCRIPTIONS**: `Record`\<[`OdehZone`](../type-aliases/OdehZone.md), `string`\>
Defined in: [types.ts:216](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L216) Defined in: [types.ts:216](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L216)
Human-readable descriptions for each Odeh visibility zone (AD). Human-readable descriptions for each Odeh visibility zone (AD).
Sourced from Odeh (Experimental Astronomy, 2006). Sourced from Odeh (Experimental Astronomy, 2006).

View file

@ -8,7 +8,7 @@
> `const` **ODEH\_THRESHOLDS**: `object` > `const` **ODEH\_THRESHOLDS**: `object`
Defined in: [types.ts:206](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L206) Defined in: [types.ts:206](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L206)
Published V thresholds (Odeh 2006): Published V thresholds (Odeh 2006):
A: V >= 5.65 — Visible with naked eye A: V >= 5.65 — Visible with naked eye

View file

@ -8,7 +8,7 @@
> `const` **WGS84**: `object` > `const` **WGS84**: `object`
Defined in: [types.ts:439](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L439) Defined in: [types.ts:439](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L439)
WGS84 reference ellipsoid parameters WGS84 reference ellipsoid parameters

View file

@ -8,7 +8,7 @@
> `const` **YALLOP\_DESCRIPTIONS**: `Record`\<[`YallopCategory`](../type-aliases/YallopCategory.md), `string`\> > `const` **YALLOP\_DESCRIPTIONS**: `Record`\<[`YallopCategory`](../type-aliases/YallopCategory.md), `string`\>
Defined in: [types.ts:167](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L167) Defined in: [types.ts:167](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L167)
Human-readable descriptions for each Yallop visibility category (AF). Human-readable descriptions for each Yallop visibility category (AF).
Sourced from Yallop (NAO TN 69, 1997). Sourced from Yallop (NAO TN 69, 1997).

View file

@ -8,7 +8,7 @@
> `const` **YALLOP\_THRESHOLDS**: `object` > `const` **YALLOP\_THRESHOLDS**: `object`
Defined in: [types.ts:155](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/types.ts#L155) Defined in: [types.ts:155](https://github.com/acamarata/moon-sighting/blob/2992dcee216cb24cc74542f6e8d5a6f4f0d16e05/src/types.ts#L155)
Published q thresholds (Yallop 1997, NAO TN 69): Published q thresholds (Yallop 1997, NAO TN 69):
A: q > +0.216 — Easily visible to the naked eye A: q > +0.216 — Easily visible to the naked eye