@polargold/pg-frontend-core
    Preparing search index...

    Interface CreateApiClientOptions

    interface CreateApiClientOptions {
        baseURL: string;
        getAcceptLanguage?: () => string;
        getAccessToken: () => string | null | undefined;
        getBasicAuthCredentials?: () => ApiClientBasicAuthCredentials | undefined;
        onForbidden?: (error: AxiosError) => void | Promise<void>;
        onServerError?: (error: AxiosError) => void | Promise<void>;
        serverErrorCodes?: number[];
    }
    Index
    baseURL getAcceptLanguage? getAccessToken getBasicAuthCredentials? onForbidden? onServerError? serverErrorCodes?
    baseURL: string

    Passed straight through to axios.create({ baseURL }).

    getAcceptLanguage?: () => string

    Called on every request; defaults to always returning "en" if omitted.

    getAccessToken: () => string | null | undefined

    Called on every request; return the current bearer token, or null/undefined if there is none yet.

    getBasicAuthCredentials?: () => ApiClientBasicAuthCredentials | undefined

    Called on every request; return credentials to send HTTP Basic Auth, or undefined to skip it.

    onForbidden?: (error: AxiosError) => void | Promise<void>

    Called on a 403 response, unless the request's own config sets suppressForbiddenRedirect: true. Typically wired to a router push (e.g. to a "not allowed" page).

    onServerError?: (error: AxiosError) => void | Promise<void>

    Called on a response whose status is in serverErrorCodes. Typically wired to a router push (e.g. to a generic error page).

    serverErrorCodes?: number[]

    Status codes treated as "server error" for onServerError. Defaults to [500, 502, 503, 504].

    Settings
    Member Visibility

    On This Page
    Properties