Interface: RankOptions
Defined in: scan.ts:48
astroengine scan -- long-scan ergonomics over the engine: a batched scan with progress, and rankMoments to find the best instants by a score, synchronously or without blocking the event loop.
This is control flow over the validated primitives, not new ephemeris. The score function is yours: compose it from positions, aspects, or the electional state. scan imposes no scoring model. Because the core engine does no I/O, these helpers (and the engine calls inside your score) run unchanged inside a Web Worker; rankMomentsAsync additionally yields to the event loop so a main-thread scan of hundreds of charts keeps the UI responsive.
Extends
Properties
end
end: number;
Defined in: scan.ts:18
Last instant, UT Julian Day (inclusive).
Inherited from
limit?
optional limit?: number;
Defined in: scan.ts:50
Keep only the top N moments (default: all).
minScore?
optional minScore?: number;
Defined in: scan.ts:52
Drop moments scoring below this (default: keep all).
onProgress?
optional onProgress?: (done, total) => void;
Defined in: scan.ts:22
Called with (done, total) sample counts during the scan.
Parameters
done
number
total
number
Returns
void
Inherited from
progressEvery?
optional progressEvery?: number;
Defined in: scan.ts:24
Samples between progress callbacks (default 256).
Inherited from
start
start: number;
Defined in: scan.ts:16
First instant, UT Julian Day (inclusive).
Inherited from
step
step: number;
Defined in: scan.ts:20
Spacing between samples, days. Must be positive.