Class REST

constructor

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

  Parameters

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

    • 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>

  Returns REST

Readonlyoptions

token

delete

• delete<R>(route: `/${string}`, options?: RequestOptions): Promise<R>

  Sends a DELETE request to the API.

  Type Parameters

  • R

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions

  Returns Promise<R>

get

• get<R>(route: `/${string}`, options?: RequestOptions): Promise<R>

  Sends a GET request to the API.

  Type Parameters

  • R

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions

  Returns Promise<R>

patch

• patch<R>(route: `/${string}`, options?: RequestOptions): Promise<R>

  Sends a PATCH request to the API.

  Type Parameters

  • R

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions

  Returns Promise<R>

post

• post<R>(route: `/${string}`, options?: RequestOptions): Promise<R>

  Sends a POST request to the API.

  Type Parameters

  • R

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions

  Returns Promise<R>

put

• put<R>(route: `/${string}`, options?: RequestOptions): Promise<R>

  Sends a PUT request to the API.

  Type Parameters

  • R

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions

  Returns Promise<R>