Logos DX
    Preparing search index...

    Interface RateLimitEventData<S, H, P>

    Event data for rate limit events.

    Extends base event data with rate limiting-specific fields.

    interface RateLimitEventData<S = unknown, H = unknown, P = unknown> {
        aborted?: boolean;
        attempt?: number;
        capacity: number;
        currentTokens: number;
        data?: unknown;
        delay?: number;
        error?: Error | FetchError<{}, DictAndT<H>>;
        headers?: DictAndT<H>;
        key: string;
        method?: string;
        nextAttempt?: number;
        nextAvailable: Date;
        params?: DictAndT<P>;
        path?: string;
        payload?: unknown;
        requestEnd?: number;
        requestId?: string;
        requestStart?: number;
        response?: Response;
        state: S;
        status?: number;
        step?: "response" | "fetch" | "parse";
        url?: string | URL;
        waitTimeMs: number;
    }

    Type Parameters

    • S = unknown

      Instance state type

    • H = unknown

      Instance headers type

    • P = unknown

      Instance params type

    Hierarchy (View Summary)

    Index

    Properties

    aborted? attempt? capacity currentTokens data? delay? error? headers? key method? nextAttempt? nextAvailable params? path? payload? requestEnd? requestId? requestStart? response? state status? step? url? waitTimeMs

    Properties

    aborted?: boolean
    attempt?: number
    capacity: number

    Maximum capacity of the bucket

    currentTokens: number

    Current tokens available in the bucket

    data?: unknown
    delay?: number
    error?: Error | FetchError<{}, DictAndT<H>>
    headers?: DictAndT<H>
    key: string

    The rate limit bucket key

    method?: string
    nextAttempt?: number
    nextAvailable: Date

    When the next token will be available

    params?: DictAndT<P>
    path?: string
    payload?: unknown
    requestEnd?: number

    Timestamp (ms) when the request resolved (success, error, or abort)

    requestId?: string

    Unique ID for this request, flows through all events

    requestStart?: number

    Timestamp (ms) when the request entered the execution pipeline

    response?: Response
    state: S
    status?: number
    step?: "response" | "fetch" | "parse"
    url?: string | URL
    waitTimeMs: number

    Time to wait before next token is available (ms)

    Settings

    Member Visibility

    On This Page

    Properties