Class REST

constructor

• new REST(options?: Partial<RESTOptions>): REST

• Parameters

  • Optionaloptions: Partial<RESTOptions>

  Returns REST

Readonlyclient

Readonlyoptions

delete

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

• Sends a DELETE request to the API.

  Type Parameters

  • B = unknown
  • R = unknown
  • Q = unknown

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions<B, Q>

  Returns Promise<R>

get

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

• Sends a GET request to the API.

  Type Parameters

  • R = unknown
  • Q = unknown

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions<never, Q>

  Returns Promise<R>

patch

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

• Sends a PATCH request to the API.

  Type Parameters

  • B = unknown
  • R = unknown
  • Q = unknown

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions<B, Q>

  Returns Promise<R>

post

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

• Sends a POST request to the API.

  Type Parameters

  • B = unknown
  • R = unknown
  • Q = unknown

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions<B, Q>

  Returns Promise<R>

put

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

• Sends a PUT request to the API.

  Type Parameters

  • B = unknown
  • R = unknown
  • Q = unknown

  Parameters

  • route: `/${string}`
  • Optionaloptions: RequestOptions<B, Q>

  Returns Promise<R>

request

• request<B = unknown, R = unknown>(
      options: InternalRequestOptions<B>,
  ): Promise<R>

• Sends a request to the API.

  Type Parameters

  • B = unknown
  • R = unknown

  Parameters

  • options: InternalRequestOptions<B>

  Returns Promise<R>

setToken

• setToken(token: null | string): null | string

• Sets the authorization token that should be used for requests.

  Parameters

  • token: null | string

  Returns null | string