Auth0 Node.js SDK - v5.1.0
    Preparing search index...

    Interface BaseClientOptions

    interface BaseClientOptions {
        environment?: Supplier<string>;
        baseUrl?: Supplier<string>;
        token: Supplier<string>;
        headers?: Record<string, Supplier<string | null | undefined>>;
        timeoutInSeconds?: number;
        maxRetries?: number;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        fetcher?: FetchFunction;
    }

    Hierarchy (View Summary)

    Index

    Properties

    environment? baseUrl? token headers? timeoutInSeconds? maxRetries? fetch? fetcher?

    Properties

    environment?: Supplier<string>
    baseUrl?: Supplier<string>

    Specify a custom URL to connect the client to.

    token: Supplier<string>
    headers?: Record<string, Supplier<string | null | undefined>>

    Additional headers to include in requests.

    timeoutInSeconds?: number

    The default maximum time to wait for a response in seconds.

    maxRetries?: number

    The default number of times to retry the request. Defaults to 2.

    fetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation.

    Type Declaration

      • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    fetcher?: FetchFunction

    Settings

    Member Visibility

    On This Page

    Properties