Skip to content

MessagesRoute

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

A route that lists things and can follow its pages.

MessagesRoute(id): MessageNode

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

A route that lists things and can follow its pages.

RouteId

MessageNode

bulkDelete: Route

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


readonly path: string

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

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

ListRoute.path

all(options?): Promise<APIMessage[]>

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

Collects pages into one array.

PageOptions<APIMessage> & object

Promise<APIMessage[]>

ListRoute.all


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

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

R = void

RouteOptions

Promise<R>

ListRoute.delete


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

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

R = APIMessage[]

RouteOptions

Promise<R>

ListRoute.get


pages(options?): AsyncGenerator<APIMessage[], void>

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

Yields one page at a time, following the cursor until the list ends.

PageOptions<APIMessage>

AsyncGenerator<APIMessage[], void>

ListRoute.pages


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

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

R = APIMessage

unknown

RouteOptions

Promise<R>

ListRoute.patch


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

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

R = APIMessage

unknown

RouteOptions

Promise<R>

ListRoute.post


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

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

R = void

unknown

RouteOptions

Promise<R>

ListRoute.put