kinetex - v1.4.0
    Preparing search index...

    Interface FetchTransportOptions

    Options for the universal fetch-based transport.

    interface FetchTransportOptions {
        fetchFn?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        strict?: boolean;
        onDroppedHeader?: (name: string, value: string) => void;
        dispatcher?: unknown;
    }
    Index
    fetchFn? strict? onDroppedHeader? dispatcher?
    fetchFn?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Custom fetch implementation. Defaults to globalThis.fetch.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    strict?: boolean

    When true, invalid headers cause a KinetexError instead of being silently dropped. Recommended for strict/production environments where silent data loss is unacceptable.

    Default: false (drop & warn).

    https://github.com/kinetexjs/kinetex/docs/strict-headers.md

    onDroppedHeader?: (name: string, value: string) => void

    Called whenever a header is dropped due to an invalid name or value. Useful for logging or monitoring header sanitization in non-strict mode.

    Type Declaration

      • (name: string, value: string): void

      • Parameters

        • name: string

          The header name that was dropped.

        • value: string

          The header value that was dropped.

        Returns void

    dispatcher?: unknown

    A fetch implementation extension passed straight through to the runtime, most usefully an undici dispatcher (Agent, ProxyAgent, MockAgent).

    Typed as unknown so this stays dependency-free — kinetex never imports, constructs, or type-checks against undici, it only forwards the value. Whether the runtime honours it is up to that runtime: Node's fetch reads init.dispatcher, Deno and Bun ignore it.

    Supplying a dispatcher forces FetchTransport, because the Node HTTP/2 transport talks to node:http2 directly and has no notion of one.

    Settings
    Member Visibility

    On This Page
    Properties