Reference · v0.11.0
API Reference
Generated from the caelus package with TypeDoc. Regenerate with npm run docs:api. The tiers below mark what to build against; the full alphabetical index follows. See Edge Cases & Stability for the versioning contract.
Recommended
The surface most applications build against. Start here.
Advanced
Stable but specialized: reach for these when the recommended surface does not cover the case. The Engine already calls most of them for you.
Internal / unstable
The engine's own astronomy machinery — series evaluators, apparent-position builders, and raw constants. Exported for inspection and tests; not a stable contract. Prefer the Engine over calling these directly.
Full index
caelus
Classes
Interfaces
- AngleLines
- Aspect
- AspectMatch
- CalcOptions
- Chart
- ChartOptions
- CompiledForm
- CompileOptions
- DeclinationPair
- EngineData
- EphemerisOptions
- EphemerisPoint
- FeatureOptions
- LunarEclipse
- Observer
- Pheno
- PlanetaryHour
- Position
- Predicate
- RankedMoment
- RankOptions
- RiseSetOptions
- ScanOptions
- SearchConfigOptions
- SolarEclipse
- StarEntry
- StarPack
- TurboBody
- TurboPack
- VoidOfCourse
- WhenOptions
- XyzSource
Type Aliases
- AspectPhase
- Ayanamsa
- Body
- BodyId
- ChebData
- Constraint
- DeclinationKind
- EphemerisValue
- HouseSystem
- Interval
- KeplerElements
- KeplerPack
- MoonSeries
- PhaseName
- RiseKind
- SolarPhase
- Vec3
- VsopSeries
- Zodiac
Variables
- ARCSEC
- ASPECTS
- AYANAMSA_J2000
- BODIES
- CAZIMI_DEG
- COMBUST_DEG
- DEFAULT_BODIES
- DEFAULT_ORBS
- DEG
- DIAMETER_KM
- EARTH_RADIUS_AU
- EXTRA_BODIES
- J2000
- LIGHT_TIME_AU
- QUERY_ASPECTS
- SIGNS
- TROPICAL_YEAR
- UNDER_BEAMS_DEG
Functions
- allOf
- angles
- angularity
- angularSeparation3d
- antiscion
- anyOf
- aspect
- aspectBetween
- aspectPhase
- astrocartography
- ayanamsa
- azAlt
- chartFeatures
- chironApparent
- compileForm
- compositeLongitudes
- configurationFit
- constraintLoss
- contraAntiscion
- cosineSimilarity
- crossings
- davisonParams
- declinationAspect
- declinationAspects
- deltaT
- dignities
- dignityOf
- directedLongitude
- ephemeris
- equationOfTime
- equatorial
- featureVector
- findAspects
- fmtLon
- formLoss
- gast
- gauquelinSector
- gmst
- harmonicChart
- harmonicLongitude
- houseCusp
- houseOf
- housesAlcabitius
- housesCampanus
- housesEqual
- housesKoch
- housesMeridian
- housesMorinus
- housesPlacidus
- housesPolichPage
- housesPorphyry
- housesRegiomontanus
- housesVehlow
- housesWholeSign
- inSect
- inSign
- isDayChart
- jdTT
- julianDay
- lunarEclipses
- lunarPhases
- lunarReturn
- meanLilith
- meanNode
- meanObliquity
- midpointLon
- mod
- moonApparentPrecise
- moonApparentSeries
- moonGeometric
- notOf
- notRetrograde
- nutation
- oscApogeePrecise
- oscApogeeSeries
- outOfBounds
- outOfBoundsMargin
- pheno
- planetApparent
- planetaryHour
- planetarySect
- planetLines
- plutoApparent
- plutoHeliocentric
- precessEcliptic
- progressedJd
- progressedLongitude
- rankMoments
- rankMomentsAsync
- refractApparentToTrue
- refractTrueToApparent
- retrograde
- returns
- riseSet
- sampleCount
- scan
- searchConfigurations
- separation
- signedElongation
- solarArc
- solarEclipses
- solarElongation
- solarPhase
- solarReturn
- starApparent
- stations
- sunApparent
- topocentricEcl
- trueNodePrecise
- trueNodeSeries
- trueObliquity
- unitVector
- vertexEastPoint
- voidOfCourse
- vsopHeliocentric
- when