Interface SweepOptions

Options for building/launching a sweep.

interface SweepOptions {
    id?: string;
    launchDelayMs?: number;
    maxConcurrent?: number;
    name?: string;
    nowMs?: number;
}

Properties

id?: string

Explicit sweep id. Normally generated from nowMs; pass this to make a sweep's ids fully deterministic (tests) or to resume a known id.

launchDelayMs?: number

Min ms between launches. Passed to FanOut.

maxConcurrent?: number

Max instances running at once (0 = all at once). Passed to FanOut.

name?: string

Sweep name; also the launched instances' name prefix. Default "sweep".

nowMs?: number

Time (ms epoch) used to stamp a generated sweep id. Required if id unset.