@runloop/remote-agents-sdk
    Preparing search index...

    Interface StreamResubscribeOptions

    interface StreamResubscribeOptions {
        baseDelayMs?: number;
        log?: LogFn;
        maxDelayMs?: number;
        signal?: AbortSignal;
        successIntervalMs?: number;
        isTerminalError?(error: unknown): boolean;
        onRetry?(info: ResubscribeRetryInfo): void;
        random?(): number;
        runAttempt(reportActivity: () => void): Promise<ResubscribeAttemptOutcome>;
        shouldStop(): boolean;
        sleep?(ms: number, signal?: AbortSignal): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseDelayMs?: number

    Base backoff delay in milliseconds.

    500
    
    log?: LogFn

    Diagnostic log callback.

    maxDelayMs?: number

    Backoff delay cap in milliseconds.

    30000
    
    signal?: AbortSignal

    Abort signal that cancels an in-progress backoff sleep.

    successIntervalMs?: number

    Minimum attempt duration that counts as a successful read even with zero events.

    30000
    

    Methods

    • Performs one subscribe-and-consume cycle. Call reportActivity() for every event received so the engine can reset its failure counter. Return "ended" on a clean stream end, "stop" when the attempt already finalized the connection, or throw on error.

      Parameters

      • reportActivity: () => void

      Returns Promise<ResubscribeAttemptOutcome>