Logos DX
    Preparing search index...

    Interface CacheEventData<S, H, P>

    Event data for cache events.

    Extends base event data with cache-specific fields.

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

    Type Parameters

    • S = unknown

      Instance state type

    • H = unknown

      Instance headers type

    • P = unknown

      Instance params type

    Hierarchy (View Summary)

    Index

    Properties

    aborted? attempt? data? delay? error? expiresIn? headers? isStale? key method? nextAttempt? outcome? params? path? payload? requestEnd? requestId? requestStart? response? state status? step? url?

    Properties

    aborted?: boolean
    attempt?: number
    data?: unknown
    delay?: number
    error?: Error | FetchError<DictAndT<H>>
    expiresIn?: number

    Time until expiration (ms)

    headers?: DictAndT<H>
    isStale?: boolean

    Whether the cache entry is stale (SWR)

    key: string

    The generated cache key

    method?: string
    nextAttempt?: number
    outcome?:
        | FetchResponse<unknown, DictAndT<H>, DictAndT<P>>
        | FetchError<DictAndT<H>>

    The cause of a cache-revalidate-error: either a transport FetchError or a resolved ok: false FetchResponse (a non-2xx revalidation never throws under resolve-on-response, so the cause isn't always an Error).

    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?: "fetch" | "parse"
    url?: string | URL

    Settings

    Member Visibility

    On This Page

    Properties