footprintjs - v11.2.0
    Preparing search index...

    Interface AttemptOptions

    How a standalone attempt series is named, timed and reported.

    interface AttemptOptions {
        deadline?: number;
        idempotencyKey?: string;
        onAttempt?: (record: AttemptRecord) => void;
        onEnd?: (summary: AttemptSummary) => void;
        series?: string;
        signal?: AbortSignal;
        target?: string;
        touches?: string;
    }
    Index
    deadline?: number

    The deadline, epoch milliseconds: every attempt is capped by the time left before it.

    idempotencyKey?: string
    onAttempt?: (record: AttemptRecord) => void

    Every attempt, at its end — the only place a standalone record goes. A throw from it is isolated: it never changes the call's outcome (dev mode warns with a fixed, non-sensitive message). Ordinary native Promise rejections are observed without waiting; arbitrary thenables/Promise proxies are unsupported.

    onEnd?: (summary: AttemptSummary) => void
    series?: string

    The series every record names — the caller's name for this one operation (an order id, a request id), so two operations can be told apart. Default: the target, else 'attempt'.

    signal?: AbortSignal

    Cancels the series: the attempt in flight is cut (aborted), a wait ends, and no attempt follows.

    target?: string

    The outside target — a name from code (1–128 characters, no control character), stamped on every record.

    touches?: string