API Reference / RankOptions · interface
Interface: RankOptions
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
| Property | Type | Description | Inherited from |
|---|---|---|---|
<a id="end"></a> end | number | Last instant, UT Julian Day (inclusive). | ScanOptions.end |
<a id="limit"></a> limit? | number | Keep only the top N moments (default: all). | - |
<a id="minscore"></a> minScore? | number | Drop moments scoring below this (default: keep all). | - |
<a id="onprogress"></a> onProgress? | (done, total) => void | Called with (done, total) sample counts during the scan. | ScanOptions.onProgress |
<a id="progressevery"></a> progressEvery? | number | Samples between progress callbacks (default 256). | ScanOptions.progressEvery |
<a id="start"></a> start | number | First instant, UT Julian Day (inclusive). | ScanOptions.start |
<a id="step"></a> step | number | Spacing between samples, days. Must be positive. | ScanOptions.step |