method WebClient.prototype.delete
WebClient.prototype.delete(
path: string,
options?: RequestOptions,
): Task<ResponseResult, HttpError>

Make a DELETE request.

Examples

Example 1

await client.delete("/users/1").run();

Parameters

path: string
  • The request path, relative to baseUrl if configured.
optional
options: RequestOptions
  • Request-specific options.

Return Type

A Task that resolves with the response or rejects with an HttpError.

Usage

import { WebClient } from ".";