spawn-ts API reference - v0.6.0
    Preparing search index...

    Interface FanOutOptions

    interface FanOutOptions {
        launchDelayMs?: number;
        maxConcurrent?: number;
        onFailure?: OnFailure;
        onProgress?: (statuses: FanOutMemberStatus[]) => void;
        retryDelayMs?: number;
    }
    Index
    launchDelayMs? maxConcurrent? onFailure? onProgress? retryDelayMs?
    launchDelayMs?: number

    Minimum wall/sim time between launches (ms). Enforced across pump() calls: at most one member launches per pump while the delay has not elapsed, so launches spread over successive monitor ticks. 0 (default) = no throttle.

    maxConcurrent?: number

    Max instances running at once. 0 (default) launches everything at once.

    onFailure?: OnFailure

    On a member's terminal failure: keep launching independent members ("continue", default) or stop launching any not-yet-started member ("stop"). Dependents of a failed member are always skipped regardless.

    onProgress?: (statuses: FanOutMemberStatus[]) => void

    Called after every pump that changes state, with a fresh status snapshot.

    retryDelayMs?: number

    Minimum time (ms) before a failed member is re-launched. 0 (default) retries on the next pump. Coarsely models pkg/queue's retry backoff.

    Settings
    Member Visibility

    On This Page
    Properties