Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/testing / RunLiveSmokeOptions

Interface: RunLiveSmokeOptions

Defined in: packages/testing/src/live.ts:60

Properties

PropertyTypeDescriptionDefined in
attempts?numberTotal attempts including the first: an integer from 1 to MAX_LIVE_SMOKE_ATTEMPTS (default 3). Anything else, NaN and Infinity included, rejects with ConfigError before any stream opens.packages/testing/src/live.ts:66
baseDelayMs?numberBackoff before retry n (1-based) is baseDelayMs * n: a non-negative integer (default 2000). Pass 0 to retry without sleeping (unit tests). The value AND the largest scheduled delay, baseDelayMs * (attempts - 1), must not exceed MAX_LIVE_SMOKE_DELAY_MS (Node's timer maximum, which would otherwise clamp the sleep to 1 ms). Anything else rejects with ConfigError before any stream opens.packages/testing/src/live.ts:76