@honua/sdk-js
    Preparing search index...

    Interface JobResultsOptions

    Bounds for IJobRun.results. Without any bound a hung or never-terminal status endpoint polls forever with no caller cancellation. Implementations pass signal through to the underlying status request, stop polling when the signal aborts or a deadline / attempt cap is reached, and use capped exponential backoff between polls.

    interface JobResultsOptions {
        deadlineMs?: number;
        maxAttempts?: number;
        maxPollIntervalMs?: number;
        pollIntervalMs?: number;
        signal?: AbortSignal;
    }
    Index

    Properties

    deadlineMs?: number

    Wall-clock budget in ms for reaching a terminal state.

    maxAttempts?: number

    Maximum number of status polls before giving up.

    maxPollIntervalMs?: number

    Cap for the exponential backoff interval in ms.

    pollIntervalMs?: number

    Base poll interval in ms (defaults to the adapter's cadence).

    signal?: AbortSignal

    Abort the poll loop (and the in-flight status request) when this fires.