IFClite TypeScript API
    Preparing search index...

    Interface FoundationHttpClientOptions

    interface FoundationHttpClientOptions {
        errorLabel?: string;
        errorNamespace?: string;
        fetchFn?: FetchLike;
        getAccessToken?: BcfTokenProvider;
    }

    Hierarchy (View Summary)

    Index
    errorLabel? errorNamespace? fetchFn? getAccessToken?
    errorLabel?: string

    Name used in the fallback "{errorLabel} request failed (HTTP …) at …" message when a non-2xx response carries no server-supplied detail. Defaults to 'OpenCDE'; a concrete client (BCF, Documents, ...) names itself so the message reads like the rest of that client's errors.

    errorNamespace?: string

    Prefix of thrown errors' name (see FoundationApiError); defaults to 'Foundation'.

    fetchFn?: FetchLike

    Injectable fetch, for tests and non-browser hosts.

    getAccessToken?: BcfTokenProvider

    Supplies the Bearer token per request; omit for anonymous servers.

    Settings
    Member Visibility

    On This Page
    Properties