@bugbug-io/sdk
    Preparing search index...

    Interface WaitOptions<T>

    Common options shared by polling/wait helpers like tests.watchRunProgress and suites.watchRunProgress.

    interface WaitOptions<T = unknown> {
        pollInterval?: number;
        timeout?: number;
        onProgress?: (data: T) => void | Promise<void>;
    }

    Type Parameters

    • T = unknown

      The polled resource type (e.g. TestRunState, SuiteRunState).

    Index

    Properties

    pollInterval? timeout? onProgress?

    Properties

    pollInterval?: number

    Poll interval in milliseconds. Default: 2_000.

    timeout?: number

    Total wait timeout in milliseconds. When omitted, each wait helper applies its own resource-appropriate default (5 minutes for tests, 10 minutes for suites).

    onProgress?: (data: T) => void | Promise<void>

    Callback invoked on every successful poll with the latest snapshot.

    Settings

    Member Visibility

    On This Page

    Properties