boundfetch
    Preparing search index...

    Interface ClientConfig<TMode, TEndpoints>

    interface ClientConfig<TMode extends ClientMode, TEndpoints extends EndpointMap> {
        baseUrl: string;
        endpoints: TEndpoints;
        fetcher?: FetcherAdapter;
        headers?: Record<string, string>;
        mode?: TMode;
        plugins?: BoundFetchPlugin[];
        security?: Partial<SecurityConfig>;
        securityProfile?: SecurityProfile;
        timeout?: number;
    }

    Type Parameters

    Index

    Properties

    baseUrl endpoints fetcher? headers? mode? plugins? security? securityProfile? timeout?

    Properties

    baseUrl: string

    Base URL used for all endpoint paths.

    endpoints: TEndpoints

    Endpoint definitions keyed by client method name.

    fetcher?: FetcherAdapter

    Custom fetch adapter. Uses global/native fetch when omitted.

    headers?: Record<string, string>

    Default headers merged into every request.

    mode?: TMode

    Return mode for endpoint calls. Defaults to throw.

    plugins?: BoundFetchPlugin[]

    Plugins executed in array order.

    security?: Partial<SecurityConfig>

    Fine-grained security overrides merged on top of the profile.

    securityProfile?: SecurityProfile

    Named security baseline. Defaults to production.

    timeout?: number

    Request timeout in milliseconds. Defaults to 30_000.

    Settings

    Member Visibility

    On This Page

    Properties