API Reference / when · function

Function: when()

function when(
   engine, 
   predicate, 
   jdStart, 
   jdEnd, 
   opts?): Interval[];

Defined in: query.ts:143

Time intervals (jdStartUt, jdEndUt) in [jdStart, jdEnd] where predicate is true. Endpoints touching the range bounds are clamped. The scan step defaults to 0.125 d when a fast body (Moon, nodes, Lilith) is involved and 1 d otherwise.

Parameters

engine

Engine

predicate

Predicate

jdStart

number

jdEnd

number

opts?

WhenOptions = {}

Returns

Interval[]