Setu-TS
    Preparing search index...

    Interface ClientOptions

    Options passed to createClient().

    0.1.0

    interface ClientOptions {
        baseUrl: string;
        circuitBreaker?: CircuitBreakerPolicy;
        fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
        headers?: HeadersInit;
        idempotency?: ClientIdempotencyOptions;
        rateLimit?: ClientRateLimitPolicy;
        requestInterceptors?: ClientRequestInterceptor[];
        responseInterceptors?: ClientResponseInterceptor<unknown>[];
        retry?: ClientRetryPolicy;
        timing?: IClientTiming;
    }
    Index
    baseUrl circuitBreaker? fetch? headers? idempotency? rateLimit? requestInterceptors? responseInterceptors? retry? timing?
    baseUrl: string

    Required base URL for all requests.

    circuitBreaker?: CircuitBreakerPolicy

    Circuit breaker policy. threshold < 1 throws at construction.

    fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>

    Injectable fetch seam. Defaults to global fetch.

    headers?: HeadersInit

    Default headers cloned into each request.

    idempotency?: ClientIdempotencyOptions

    Generated idempotency keys. Every request whose method is listed and that has no ClientRequest.idempotencyKey gets ONE generated key, reused by every retry attempt — which is how a GENERATED client gets one, since its operations take no per-call options. Omitted: only ClientRequest.idempotencyKey sets the header.

    rateLimit?: ClientRateLimitPolicy

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

    requestInterceptors?: ClientRequestInterceptor[]

    Request interceptors executed once before resilient execution.

    responseInterceptors?: ClientResponseInterceptor<unknown>[]

    Response interceptors executed after successful parsing.

    retry?: ClientRetryPolicy

    Retry policy. Invalid/non-finite counts, delays, and derived backoffs throw at construction.

    timing?: IClientTiming

    Timing abstraction. Defaults to createDefaultClientTiming().

    Settings
    Member Visibility

    On This Page
    Properties