API reference

Ephemeris

Ephemeris service contract and runtime-neutral position models.

Import from astro-ascendant/ephemeris:

import * as Ephemeris from "astro-ascendant/ephemeris";

Classes

Ephemeris

declare class Ephemeris extends Service_base {}

EphemerisError

class EphemerisError extends EphemerisError_base {}

Interfaces

NativePlanetaryPosition

interface NativePlanetaryPosition extends Schema.Schema.Type<
  typeof NativePlanetaryPosition
> {}

PositionCacheOptions

interface PositionCacheOptions {
  readonly capacity?: number | undefined;
  readonly timeToLive?: Duration.Input | undefined;
}

Constants

CelestialBody

const CelestialBody: Schema.Literals<
  readonly [
    "Sun",
    "Moon",
    "Mars",
    "Mercury",
    "Venus",
    "Jupiter",
    "Saturn",
    "TrueNode",
    "MeanNode",
  ]
>;

HouseData

const HouseData: Schema.Struct<{
  readonly cusps: Schema.$Array<Schema.Finite>;
  readonly ascendant: Schema.Finite;
  readonly mc: Schema.Finite;
  readonly armc: Schema.Finite;
  readonly vertex: Schema.Finite;
  readonly equatorialAscendant: Schema.Finite;
  readonly coAscendant1: Schema.Finite;
  readonly coAscendant2: Schema.Finite;
  readonly polarAscendant: Schema.Finite;
  readonly houseSystem: Schema.Literals<
    readonly [
      "Placidus",
      "Koch",
      "Porphyrius",
      "Regiomontanus",
      "Campanus",
      "Equal",
      "VehlowEqual",
      "WholeSign",
      "Meridian",
      "Azimuthal",
      "PolichPage",
      "Alcabitus",
      "Morinus",
    ]
  >;
}>;

JulianDay

const JulianDay: Schema.brand<Schema.Finite, "JulianDay">;

NativeHouseData

const NativeHouseData: Schema.Struct<{
  readonly cusps: Schema.$Array<Schema.Finite>;
  readonly ascendant: Schema.Finite;
  readonly mc: Schema.Finite;
  readonly armc: Schema.Finite;
  readonly vertex: Schema.Finite;
  readonly equatorialAscendant: Schema.Finite;
  readonly coAscendant1: Schema.Finite;
  readonly coAscendant2: Schema.Finite;
  readonly polarAscendant: Schema.Finite;
}>;

PlanetaryPosition

const PlanetaryPosition: Schema.Struct<{
  readonly longitude: Schema.Finite;
  readonly latitude: Schema.Finite;
  readonly distance: Schema.Finite;
  readonly longitudeSpeed: Schema.Finite;
  readonly latitudeSpeed: Schema.Finite;
  readonly distanceSpeed: Schema.Finite;
  readonly flags: Schema.Int;
}>;