WebClient.prototype.delete - default - web-client documentation

method WebClient.prototype.delete



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

Make a DELETE request.

Examples

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



path: string

The request path, relative to baseUrl if configured.

optional



options: RequestOptions

Request-specific options.

Task<ResponseResult, HttpError>

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