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

method WebClient.prototype.post



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

Make a POST request with a body.

Examples

const result = await client.post("/users", { name: "John" }).run();



path: string

The request path, relative to baseUrl if configured.



body: unknown

The request body (serialized as JSON).

optional



options: RequestOptions

Request-specific options.

Task<ResponseResult, HttpError>

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