Caelus3,462 checksGitHubv0.25.0MIT
API Reference / heliacalKindsFor · function

Function: heliacalKindsFor()

function heliacalKindsFor(
   engine, 
   target, 
   method?): (
  | "morning_first"
  | "evening_last"
  | "evening_first"
  | "morning_last"
  | "acronychal_rising"
  | "cosmical_setting")[];

The events a target has under a method, in the order heliacal names them: stars and the outer planets have the heliacal rising and setting (and, by the arcus method, the two events at opposition), Mercury and Venus have four, and the Moon has its first and last crescent by the visibility method only.

Parameters

ParameterTypeDefault valueDescription
engineEngineundefinedThe engine whose star catalog names the stars.
targetstringundefinedA planet id, "moon", or a catalog star name.
methodHeliacalMethod"visibility""visibility" (default) or "arcus".

Returns

( | "morning_first" | "evening_last" | "evening_first" | "morning_last" | "acronychal_rising" | "cosmical_setting")[]

Throws

Error for an unknown target or method.

Example

heliacalKindsFor(engine, "venus");  // four kinds
heliacalKindsFor(engine, "Sirius"); // ["morning_first", "evening_last"]

Start building

Quickstart →