FoxoChat.js Packages
    Preparing search index...

    Interface RESTOptions

    All options to be passed when creating the REST client instance.

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

    Properties

    authPrefix baseURL enforceAuth

    Methods

    request

    Properties

    authPrefix: string

    The authorization prefix to use for requests.

    baseURL: string

    The base API url.

    enforceAuth: boolean

    Enforces authorization token requirement in auth required endpoints.

    Methods

    • The method called to perform the HTTP requests.

      Parameters

      • url: RequestInfo | URL
      • init: RequestInit

      Returns Promise<ResponseLike>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods