FoxoChat.js Packages
    Preparing search index...

    Interface APIOptions

    Options to be passed when creating the API client instance.

    interface APIOptions {
        rest: {
            authPrefix?: string;
            baseURL: string;
            enforceAuth?: boolean;
            request?: (
                url: RequestInfo | URL,
                init: RequestInit,
            ) => Promise<ResponseLike>;
        };
    }
    Index

    Properties

    rest

    Properties

    rest: {
        authPrefix?: string;
        baseURL: string;
        enforceAuth?: boolean;
        request?: (
            url: RequestInfo | URL,
            init: RequestInit,
        ) => Promise<ResponseLike>;
    }

    Type declaration

    • OptionalauthPrefix?: string

      The authorization prefix to use for requests.

    • baseURL: string

      The base API url.

    • OptionalenforceAuth?: boolean

      Enforces authorization token requirement in auth required endpoints.

    • Optionalrequest?: (url: RequestInfo | URL, init: RequestInit) => Promise<ResponseLike>

    Settings

    Member Visibility

    On This Page

    Properties