Skip to content

Route

Defined in: packages/core/src/api.ts:56

A place in Discord’s REST API. Send a request with get, post, put, patch or delete. Read is what get returns; Write is what post and patch return (the same, except on a list, where posting makes one item).

Read = unknown

Write = Read

readonly path: string

Defined in: packages/core/src/api.ts:58

The path this route stands for, such as /guilds/123/members.

delete<R>(options?): Promise<R>

Defined in: packages/core/src/api.ts:63

R = void

RouteOptions

Promise<R>


get<R>(options?): Promise<R>

Defined in: packages/core/src/api.ts:59

R = Read

RouteOptions

Promise<R>


patch<R>(body?, options?): Promise<R>

Defined in: packages/core/src/api.ts:62

R = Write

unknown

RouteOptions

Promise<R>


post<R>(body?, options?): Promise<R>

Defined in: packages/core/src/api.ts:60

R = Write

unknown

RouteOptions

Promise<R>


put<R>(body?, options?): Promise<R>

Defined in: packages/core/src/api.ts:61

R = void

unknown

RouteOptions

Promise<R>