Type Alias RequestOptions

RequestOptions: {
    extra_body?: Record<string, unknown>;
    extra_query?: Record<string, unknown>;
    fetch_options?: Omit<RequestInit, "method" | "body">;
    retries?: RetryConfig;
    retry_codes?: string[];
    server_url?: string | URL;
    timeout_ms?: number;
} & Omit<RequestInit, "method" | "body">

Type declaration

  • Optionalextra_body?: Record<string, unknown>

    Additional fields to merge into the JSON object request body. Entries replace any fields of the same name produced by the operation. Entries with undefined values are skipped. Setting this option on an operation whose request body is not a JSON object results in an error.

  • Optionalextra_query?: Record<string, unknown>

    Additional query parameters to set on the request URL. Entries replace any query parameters of the same name produced by the operation. Entries with null or undefined values are skipped, array values are encoded as repeated keys and plain object values are JSON-encoded.

  • Optionalfetch_options?: Omit<RequestInit, "method" | "body">

    Deprecated

    fetchOptions has been flattened into RequestOptions.

    Sets various request options on the fetch call made by an SDK method.

    See

    https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request

  • Optionalretries?: RetryConfig

    Set or override a retry policy on HTTP calls.

  • Optionalretry_codes?: string[]

    Specifies the status codes which should be retried using the given retry policy.

  • Optionalserver_url?: string | URL

    Overrides the base server URL that will be used by an operation.

  • Optionaltimeout_ms?: number

    Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If fetchOptions.signal is set then it will take precedence over this option.

Settings