Skip to content

MembersRoute

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

A route that lists things and can follow its pages.

MembersRoute(userId): MemberNode

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

A route that lists things and can follow its pages.

RouteId

MemberNode

readonly path: string

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

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

ListRoute.path


search: Route<APIGuildMember[]>

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

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

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

Collects pages into one array.

PageOptions<APIGuildMember> & object

Promise<APIGuildMember[]>

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 = APIGuildMember[]

RouteOptions

Promise<R>

ListRoute.get


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

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

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

PageOptions<APIGuildMember>

AsyncGenerator<APIGuildMember[], void>

ListRoute.pages


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

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

R = APIGuildMember

unknown

RouteOptions

Promise<R>

ListRoute.patch


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

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

R = APIGuildMember

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