ListRoute
Defined in: packages/core/src/api.ts:67
A route that lists things and can follow its pages.
Extends
Section titled “Extends”Route<Item[],Item>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Item
Properties
Section titled “Properties”
readonlypath:string
Defined in: packages/core/src/api.ts:58
The path this route stands for, such as /guilds/123/members.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”all(
options?):Promise<Item[]>
Defined in: packages/core/src/api.ts:74
Collects pages into one array.
Parameters
Section titled “Parameters”options?
Section titled “options?”PageOptions<Item> & object
Returns
Section titled “Returns”Promise<Item[]>
delete()
Section titled “delete()”delete<
R>(options?):Promise<R>
Defined in: packages/core/src/api.ts:63
Type Parameters
Section titled “Type Parameters”R = void
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>
Inherited from
Section titled “Inherited from”get<
R>(options?):Promise<R>
Defined in: packages/core/src/api.ts:59
Type Parameters
Section titled “Type Parameters”R = Item[]
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>
Inherited from
Section titled “Inherited from”pages()
Section titled “pages()”pages(
options?):AsyncGenerator<Item[],void>
Defined in: packages/core/src/api.ts:69
Yields one page at a time, following the cursor until the list ends.
Parameters
Section titled “Parameters”options?
Section titled “options?”PageOptions<Item>
Returns
Section titled “Returns”AsyncGenerator<Item[], void>
patch()
Section titled “patch()”patch<
R>(body?,options?):Promise<R>
Defined in: packages/core/src/api.ts:62
Type Parameters
Section titled “Type Parameters”R = Item
Parameters
Section titled “Parameters”unknown
options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>
Inherited from
Section titled “Inherited from”post()
Section titled “post()”post<
R>(body?,options?):Promise<R>
Defined in: packages/core/src/api.ts:60
Type Parameters
Section titled “Type Parameters”R = Item
Parameters
Section titled “Parameters”unknown
options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>
Inherited from
Section titled “Inherited from”put<
R>(body?,options?):Promise<R>
Defined in: packages/core/src/api.ts:61
Type Parameters
Section titled “Type Parameters”R = void
Parameters
Section titled “Parameters”unknown
options?
Section titled “options?”Returns
Section titled “Returns”Promise<R>