@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface SsrfFetchOptions

    interface SsrfFetchOptions {
        method?: string;
        headers?: Record<string, string>;
        body?: string | Uint8Array<ArrayBufferLike>;
        allowPrivateIp?: boolean;
        timeoutMs?: number;
        maxBodyBytes?: number;
        signal?: AbortSignal;
        lookup?: SsrfDnsLookup;
        tls?: { cert?: string; key?: string; passphrase?: string; ca?: string };
        trustedFetchFn?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
    }
    Index
    method? headers? body? allowPrivateIp? timeoutMs? maxBodyBytes? signal? lookup? tls? trustedFetchFn?
    method?: string
    headers?: Record<string, string>

    Lowercased keys preferred; values preserved verbatim.

    Optionalbody

    body?: string | Uint8Array<ArrayBufferLike>
    allowPrivateIp?: boolean

    Allow http:// and private/loopback targets. Default false.

    timeoutMs?: number

    Overall timeout including DNS + connect + body read. Default 10_000 ms.

    maxBodyBytes?: number

    Hard cap on response body bytes. Default 64 KiB.

    signal?: AbortSignal

    Caller-provided abort signal, composed with the internal timeout.

    lookup?: SsrfDnsLookup

    DNS resolver override for dependency injection. Every returned address is still classified by the SSRF policy, and the selected address is still pinned into the undici dispatcher. Defaults to dns/promises.lookup.

    tls?: { cert?: string; key?: string; passphrase?: string; ca?: string }

    Declarative client-authentication material for a runner-owned HTTPS connection. Certificate verification remains enabled and SNI is always derived from the validated URL hostname; callers cannot override either.

    trustedFetchFn?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Trusted scoped fetch implementation. URL scheme validation, redirect handling, timeouts, and body limits still run, but DNS resolution and address policy are delegated to this implementation because custom fetchers do not accept undici dispatchers. The caller MUST enforce DNS-rebinding and private-address policy itself.

    This deliberately explicit name prevents callers from mistaking a custom transport for the internally DNS-pinned path.

    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>

    Settings
    Member Visibility

    On This Page
    Properties