kinetex - v1.4.0
    Preparing search index...

    Interface KinetexRequest<M>

    Fully-resolved request object passed through the pipeline.

    interface KinetexRequest<M extends HTTPMethod = HTTPMethod> {
        url: string;
        method: M;
        headers: Record<string, string>;
        body: BodyInit;
        signal: AbortSignal | null;
        meta: Record<string, unknown>;
        httpVersion?: HTTPVersion;
        redirect?: "error" | "follow" | "manual";
        followRedirects?: boolean;
        maxRedirects?: number;
    }

    Type Parameters

    Index
    url method headers body signal meta httpVersion? redirect? followRedirects? maxRedirects?
    url: string

    Fully-qualified URL string.

    method: M

    HTTP method.

    headers: Record<string, string>

    Normalized request headers (lowercase keys).

    Readonlybody

    body: BodyInit

    Serialized request body (null for bodyless methods).

    signal: AbortSignal | null

    AbortSignal for cancellation.

    meta: Record<string, unknown>

    Arbitrary per-request metadata — freely readable/writable by hooks.

    httpVersion?: HTTPVersion

    Preferred HTTP version. Falls back if unavailable.

    redirect?: "error" | "follow" | "manual"

    Redirect mode passed to fetch.

    • "follow" (default) — automatically follow redirects.
    • "manual" — return the redirect response as-is (used internally for cookie-jar redirect following).
    • "error" — throw on any redirect.
    followRedirects?: boolean

    Whether redirects are followed. false returns the 3xx response as-is, matching redirect: "manual". Default: true.

    maxRedirects?: number

    Maximum number of redirect hops to follow. 0 disables following. Default: 20 (browser-compatible).

    Settings
    Member Visibility

    On This Page
    Properties