@astronomy-bundle/solar-eclipse 9.0.0

package/README.md

@@ -0,0 +1 @@
+// TODO

package/index.d.mts

@@ -0,0 +1,154 @@
+declare class Location {
+    readonly lat: number;
+    readonly lon: number;
+    readonly elevation: number;
+    private readonly location;
+    private prefixesNorthSouth;
+    private prefixesEastWest;
+    constructor(lat: number, lon: number, elevation?: number);
+    static create(lat: number, lon: number, elevation?: number): Location;
+    getLatitude(): number;
+    getLongitude(): number;
+    getLatitudeInDegreeMinutes(): string;
+    getLongitudeInDegreeMinutes(): string;
+    getLatitudeInDegreeMinutesSeconds(): string;
+    getLongitudeInDegreeMinutesSeconds(): string;
+    getElevation(): number;
+    getDistanceToInKm(location: Location): number;
+}
+
+interface LatLon {
+    lat: number;
+    lon: number;
+}
+
+type Time = {
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    min: number;
+    sec: number;
+};
+
+declare class TimeOfInterest {
+    readonly time: Time;
+    readonly jd: number;
+    readonly T: number;
+    constructor(time: Time);
+    static fromCurrentTime(): TimeOfInterest;
+    static fromTime(year: number, month: number, day: number, hour?: number, min?: number, sec?: number): TimeOfInterest;
+    static fromDate(date: Date): TimeOfInterest;
+    static fromYearOfDay(year: number, dayOfYear: number): TimeOfInterest;
+    static fromJulianDay(jd: number): TimeOfInterest;
+    static fromJulianCenturiesJ2000(T: number): TimeOfInterest;
+    getTime(): Time;
+    getString(): string;
+    getDate(): Date;
+    getDecimalYear(): number;
+    getDayOfYear(): number;
+    getDayOfWeek(): number;
+    isLeapYear(): boolean;
+    getJulianDay(): number;
+    getJulianDay0(): number;
+    getJulianCenturiesJ2000(): number;
+    getJulianMillenniaJ2000(): number;
+    getGreenwichMeanSiderealTime(): number;
+    getGreenwichApparentSiderealTime(): number;
+    getLocalMeanSiderealTime(location: LatLon): number;
+    getLocalApparentSiderealTime(location: LatLon): number;
+    getDeltaT(): number;
+}
+
+declare enum SolarEclipseType {
+    Partial = "partial",
+    Total = "total",
+    Annular = "annular",
+    Hybrid = "hybrid"
+}
+declare enum LocalSolarEclipseType {
+    Partial = "partial",
+    Total = "total",
+    Annular = "annular"
+}
+
+interface BesselianElements {
+    t0Jde: number;
+    t0Hours: number;
+    tMin: number;
+    tMax: number;
+    deltaT: number;
+    x: Array<number>;
+    y: Array<number>;
+    d: Array<number>;
+    mu: Array<number>;
+    l1: Array<number>;
+    l2: Array<number>;
+    tanF1: number;
+    tanF2: number;
+}
+
+declare class LocalEclipseCircumstances {
+    private readonly elements;
+    private readonly location;
+    private readonly toi;
+    private readonly tau;
+    private readonly snap;
+    private constructor();
+    static create(elements: BesselianElements, location: Location, toi: TimeOfInterest): LocalEclipseCircumstances;
+    getLocation(): Location;
+    getTimeOfInterest(): TimeOfInterest;
+    getType(): LocalSolarEclipseType;
+    isInEclipse(): boolean;
+    isInCentralEclipse(): boolean;
+    getMagnitude(): number;
+    getObscuration(): number;
+    getSunAltitude(): number;
+    getMoonAltitude(): number;
+}
+
+interface EclipseContacts {
+    c1: Date;
+    c2: Date | null;
+    max: Date;
+    c3: Date | null;
+    c4: Date;
+}
+interface EclipseContactsTau {
+    c1: number;
+    c2: number | null;
+    max: number;
+    c3: number | null;
+    c4: number;
+}
+
+declare class LocalSolarEclipse {
+    private readonly elements;
+    private readonly location;
+    private readonly contactTaus;
+    private constructor();
+    static create(elements: BesselianElements, location: Location): LocalSolarEclipse;
+    getCircumstances(toi: TimeOfInterest): LocalEclipseCircumstances;
+    getType(): LocalSolarEclipseType;
+    getContactTaus(): EclipseContactsTau | null;
+    getContactTimes(): EclipseContacts;
+    getDuration(): number;
+    getCentralDuration(): number | null;
+}
+
+declare class SolarEclipse {
+    private readonly elements;
+    private constructor();
+    static createFromDate(date: string): SolarEclipse;
+    static createFromToi(toi: TimeOfInterest): SolarEclipse;
+    static createFromBesselianElements(elements: BesselianElements): SolarEclipse;
+    getLocalEclipse(location: Location): LocalSolarEclipse;
+    getType(): SolarEclipseType;
+    getMaxObscuration(): number;
+    getMaxDuration(): number;
+    getMaxCentralDuration(): number;
+    getSarosNumber(): number;
+    getLocationOfGreatestEclipse(): Location;
+}
+
+export { LocalEclipseCircumstances, LocalSolarEclipse, SolarEclipse };

package/index.d.ts

@@ -0,0 +1,154 @@
+declare class Location {
+    readonly lat: number;
+    readonly lon: number;
+    readonly elevation: number;
+    private readonly location;
+    private prefixesNorthSouth;
+    private prefixesEastWest;
+    constructor(lat: number, lon: number, elevation?: number);
+    static create(lat: number, lon: number, elevation?: number): Location;
+    getLatitude(): number;
+    getLongitude(): number;
+    getLatitudeInDegreeMinutes(): string;
+    getLongitudeInDegreeMinutes(): string;
+    getLatitudeInDegreeMinutesSeconds(): string;
+    getLongitudeInDegreeMinutesSeconds(): string;
+    getElevation(): number;
+    getDistanceToInKm(location: Location): number;
+}
+
+interface LatLon {
+    lat: number;
+    lon: number;
+}
+
+type Time = {
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    min: number;
+    sec: number;
+};
+
+declare class TimeOfInterest {
+    readonly time: Time;
+    readonly jd: number;
+    readonly T: number;
+    constructor(time: Time);
+    static fromCurrentTime(): TimeOfInterest;
+    static fromTime(year: number, month: number, day: number, hour?: number, min?: number, sec?: number): TimeOfInterest;
+    static fromDate(date: Date): TimeOfInterest;
+    static fromYearOfDay(year: number, dayOfYear: number): TimeOfInterest;
+    static fromJulianDay(jd: number): TimeOfInterest;
+    static fromJulianCenturiesJ2000(T: number): TimeOfInterest;
+    getTime(): Time;
+    getString(): string;
+    getDate(): Date;
+    getDecimalYear(): number;
+    getDayOfYear(): number;
+    getDayOfWeek(): number;
+    isLeapYear(): boolean;
+    getJulianDay(): number;
+    getJulianDay0(): number;
+    getJulianCenturiesJ2000(): number;
+    getJulianMillenniaJ2000(): number;
+    getGreenwichMeanSiderealTime(): number;
+    getGreenwichApparentSiderealTime(): number;
+    getLocalMeanSiderealTime(location: LatLon): number;
+    getLocalApparentSiderealTime(location: LatLon): number;
+    getDeltaT(): number;
+}
+
+declare enum SolarEclipseType {
+    Partial = "partial",
+    Total = "total",
+    Annular = "annular",
+    Hybrid = "hybrid"
+}
+declare enum LocalSolarEclipseType {
+    Partial = "partial",
+    Total = "total",
+    Annular = "annular"
+}
+
+interface BesselianElements {
+    t0Jde: number;
+    t0Hours: number;
+    tMin: number;
+    tMax: number;
+    deltaT: number;
+    x: Array<number>;
+    y: Array<number>;
+    d: Array<number>;
+    mu: Array<number>;
+    l1: Array<number>;
+    l2: Array<number>;
+    tanF1: number;
+    tanF2: number;
+}
+
+declare class LocalEclipseCircumstances {
+    private readonly elements;
+    private readonly location;
+    private readonly toi;
+    private readonly tau;
+    private readonly snap;
+    private constructor();
+    static create(elements: BesselianElements, location: Location, toi: TimeOfInterest): LocalEclipseCircumstances;
+    getLocation(): Location;
+    getTimeOfInterest(): TimeOfInterest;
+    getType(): LocalSolarEclipseType;
+    isInEclipse(): boolean;
+    isInCentralEclipse(): boolean;
+    getMagnitude(): number;
+    getObscuration(): number;
+    getSunAltitude(): number;
+    getMoonAltitude(): number;
+}
+
+interface EclipseContacts {
+    c1: Date;
+    c2: Date | null;
+    max: Date;
+    c3: Date | null;
+    c4: Date;
+}
+interface EclipseContactsTau {
+    c1: number;
+    c2: number | null;
+    max: number;
+    c3: number | null;
+    c4: number;
+}
+
+declare class LocalSolarEclipse {
+    private readonly elements;
+    private readonly location;
+    private readonly contactTaus;
+    private constructor();
+    static create(elements: BesselianElements, location: Location): LocalSolarEclipse;
+    getCircumstances(toi: TimeOfInterest): LocalEclipseCircumstances;
+    getType(): LocalSolarEclipseType;
+    getContactTaus(): EclipseContactsTau | null;
+    getContactTimes(): EclipseContacts;
+    getDuration(): number;
+    getCentralDuration(): number | null;
+}
+
+declare class SolarEclipse {
+    private readonly elements;
+    private constructor();
+    static createFromDate(date: string): SolarEclipse;
+    static createFromToi(toi: TimeOfInterest): SolarEclipse;
+    static createFromBesselianElements(elements: BesselianElements): SolarEclipse;
+    getLocalEclipse(location: Location): LocalSolarEclipse;
+    getType(): SolarEclipseType;
+    getMaxObscuration(): number;
+    getMaxDuration(): number;
+    getMaxCentralDuration(): number;
+    getSarosNumber(): number;
+    getLocationOfGreatestEclipse(): Location;
+}
+
+export { LocalEclipseCircumstances, LocalSolarEclipse, SolarEclipse };