Beignet API reference
    Preparing search index...

    Type Alias ClientConfig<TProvidedHeaders>

    Configuration for a Beignet contract client.

    type ClientConfig<TProvidedHeaders extends string = never> = {
        baseUrl?: string;
        fetch?: typeof fetch;
        headers?: () => Promise<Record<string, string>> | Record<string, string>;
        providedHeaders?: readonly TProvidedHeaders[];
        validateInput?: boolean;
        validateResponses?: boolean;
    }

    Type Parameters

    • TProvidedHeaders extends string = never
    Index
    baseUrl? fetch? headers? providedHeaders? validateInput? validateResponses?
    baseUrl?: string

    Base URL prepended to all endpoint paths.

    fetch?: typeof fetch

    Fetch implementation. Defaults to global fetch.

    headers?: () => Promise<Record<string, string>> | Record<string, string>

    Static or async headers applied to every request.

    providedHeaders?: readonly TProvidedHeaders[]

    Header keys supplied by global headers, making them optional per call.

    validateInput?: boolean

    Validate path params, query params, request bodies, and declared request headers against contract schemas before sending. Failures throw a client-source ContractError with code INPUT_VALIDATION_ERROR. Default: false.

    validateResponses?: boolean

    Validate response bodies (success and declared error responses) against contract schemas. Disabling this returns success bodies as-is and skips contract-drift checks such as undeclared response statuses. Default: true.

    Settings
    Member Visibility

    On This Page
    Properties