interface ClientOptions
Since 0.1.0

Options passed to createClient().

Properties

readonly
baseUrl: string

Required base URL for all requests.

readonly
optional
headers: HeadersInit

Default headers cloned into each request.

readonly
optional
fetch: (
input: RequestInfo,
) => Promise<Response>

Injectable fetch seam. Defaults to global fetch.

readonly
optional
timing: IClientTiming

Timing abstraction. Defaults to createDefaultClientTiming().

readonly
optional
retry: RetryPolicy

Retry policy. limit < 1 throws at construction.

Circuit breaker policy. threshold < 1 throws at construction.

Rate-limit policy. Non-positive maxRequests or windowMs throws.

Request interceptors executed once before resilient execution.

readonly
optional
responseInterceptors: ClientResponseInterceptor<unknown>[]

Response interceptors executed after successful parsing.

Usage

import { type ClientOptions } from "sdk/src/index.ts";