@gradientedge/commercetools-utils
    Preparing search index...

    Interface CommercetoolsAuthConfig

    Configuration for {@see CommercetoolsAuth}

    interface CommercetoolsAuthConfig {
        apiUrl?: string;
        authUrl?: string;
        clientId: string;
        clientScopes: string[];
        clientSecret: string;
        customerScopes?: string[];
        onAfterResponse?: (response: CommercetoolsRequestResponse) => void;
        onBeforeRequest?: (
            requestConfig: CommercetoolsRequest,
        ) =>
            | Omit<
                CommercetoolsRequest,
                "timeoutMs"
                | "retry"
                | "aggregateTimeoutMs"
                | "abortController",
            >
            | Promise<
                Omit<
                    CommercetoolsRequest,
                    "timeoutMs"
                    | "retry"
                    | "aggregateTimeoutMs"
                    | "abortController",
                >,
            >;
        projectKey: string;
        refreshIfWithinSecs?: number;
        region: Region;
        retry?: Partial<CommercetoolsRetryConfig>;
        storeKey?: string;
        systemIdentifier?: string;
        timeoutMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiUrl? authUrl? clientId clientScopes clientSecret customerScopes? onAfterResponse? onBeforeRequest? projectKey refreshIfWithinSecs? region retry? storeKey? systemIdentifier? timeoutMs?

    Properties

    apiUrl?: string

    Optional custom API endpoint URL. If provided, this will be used instead of the region-based API URL. Useful for pointing to mock servers during integration tests.

    'http://localhost:3000/api'
    authUrl?: string

    Optional custom authentication endpoint URL. If provided, this will be used instead of the region-based auth URL. Useful for pointing to mock servers during integration tests.

    'http://localhost:3000/auth'
    clientId: string
    clientScopes: string[]
    clientSecret: string
    customerScopes?: string[]
    onAfterResponse?: (response: CommercetoolsRequestResponse) => void

    If passed in, will be called once a request has been made and the response received (or error thrown).

    onBeforeRequest?: (
        requestConfig: CommercetoolsRequest,
    ) =>
        | Omit<
            CommercetoolsRequest,
            "timeoutMs"
            | "retry"
            | "aggregateTimeoutMs"
            | "abortController",
        >
        | Promise<
            Omit<
                CommercetoolsRequest,
                "timeoutMs"
                | "retry"
                | "aggregateTimeoutMs"
                | "abortController",
            >,
        >

    If passed in, will be called before sending a request to commercetools. The {@see requestConfig} parameter can be manipulated if you wish to modify/add headers or any other request data.

    projectKey: string
    refreshIfWithinSecs?: number
    region: Region
    retry?: Partial<CommercetoolsRetryConfig>
    storeKey?: string
    systemIdentifier?: string

    If provided, will be passed across to commercetools in the 'User-Agent' HTTP header, in order to help commercetools identify the source of incoming requests.

    timeoutMs?: number

    Settings

    Member Visibility

    On This Page

    Properties