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

    Interface HttpsReportingResourceReaderOptions

    interface HttpsReportingResourceReaderOptions {
        allowPrivateIp?: boolean;
        timeoutMs?: number;
        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>;
        };
        maxBodyBytes?: number;
        tlsAllowedOrigins?: readonly string[];
    }

    Hierarchy

    • Pick<
          SsrfFetchOptions,
          "allowPrivateIp"
          | "timeoutMs"
          | "trustedFetchFn"
          | "tls",
      >
      • HttpsReportingResourceReaderOptions
    Index
    allowPrivateIp? timeoutMs? tls? trustedFetchFn? maxBodyBytes? tlsAllowedOrigins?
    allowPrivateIp?: boolean

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

    timeoutMs?: number

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

    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>

    maxBodyBytes?: number
    tlsAllowedOrigins?: readonly string[]

    Exact HTTPS origins authorized to receive configured mTLS material.

    Settings
    Member Visibility

    On This Page
    Properties