TonightOptionstype
What the sky is like: all of it optional.
Import it
import type { TonightOptions } from "@johnmorrisdotca/hoshi-stars/tonight";
Definition
interface TonightOptions {
limit?: SkyLimit;
minAltitude?: number;
extinction?: number;
moonPenalty?: number;
sunAltitude?: number;
all?: boolean;
}
Members
| Name | Type | Description |
|---|---|---|
limit (optional) | SkyLimit | undefined | The site's darkness: |
minAltitude (optional) | number | undefined | The lowest altitude counted, in degrees (default 0, the horizon). Extinction takes the stars close to the horizon out whatever this is. |
extinction (optional) | number | undefined | Magnitudes lost per airmass (default 0.2, the V band at a good low site; 0.3 to 0.4 in haze). Only the part above the zenith's one airmass is taken off, since a site's limit already holds the zenith's. |
moonPenalty (optional) | number | undefined | Magnitudes the limit falls by, passed in by the caller: the Moon's glare (about 0.5 at a crescent, 2 at the full Moon, 0 when it is down). |
sunAltitude (optional) | number | undefined | The Sun's altitude in degrees, if you already know it; otherwise it is worked out from the moment. |
all (optional) | boolean | undefined | Return every star above the horizon, with |
Examples
import type { TonightOptions } from "@johnmorrisdotca/hoshi-stars/tonight";
const sky: TonightOptions = { limit: "suburb", minAltitude: 10, extinction: 0.25, moonPenalty: 1 };
console.log(sky.limit);suburbWhat it prints (run when this page was built)