satim-module - v1.0.0
    Preparing search index...

    Interface HttpClientOptions

    interface HttpClientOptions {
        maxRetries?: number;
        timeoutMs?: number;
        circuitBreaker?: false | CircuitBreakerOptions;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
    }
    Index

    Properties

    maxRetries?: number

    Maximum retries on transient failures (5xx, timeout) for idempotent calls. Clamped to [0, 10]. Default 2.

    timeoutMs?: number

    Per-request timeout in milliseconds. Default 30 000. Range: [1000, 300000] (1 second to 5 minutes).

    circuitBreaker?: false | CircuitBreakerOptions

    Circuit breaker configuration. Pass false to disable the breaker entirely (not recommended for production).

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

    Custom fetch implementation. Defaults to the global fetch.

    Inject an undici Pool-backed fetch on Node.js to enable true connection pooling and HTTP/2 multiplexing:

    import { Pool } from "undici";
    const pool = new Pool("https://cib.satim.dz");
    const satim = new Satim(credentials, { fetch: pool.fetch.bind(pool) });

    On edge runtimes (Cloudflare Workers, Vercel Edge) the global fetch already pools connections — leave this unset.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
      • Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>
      • Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>