Appearance
REST
Package: @erinjs/rest
HTTP client for the erin.js API. Used by Client internally.
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
options | RESTOptions | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
requestManager | RequestManager | Yes | No | |
Routes | any | Yes | No | Route helpers (from @erinjs/types) for building paths. |
token | string | null | Yes | No | Current bot token, or null. |
Methods
delete() async
Send a DELETE request.
Returns: Promise<T>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
route | string | No | |
options | { auth?: boolean; } | Yes |
get() async
Send a GET request.
Returns: Promise<T>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
route | string | No | |
options | { auth?: boolean; } | Yes |
patch() async
Send a PATCH request.
Returns: Promise<T>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
route | string | No | |
options | { body?: unknown; auth?: boolean; } | Yes |
post() async
Send a POST request.
Returns: Promise<T>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
route | string | No | |
options | { body?: unknown; auth?: boolean; files?: Array<{ name: string; data: Blob | ArrayBuffer | Uint8Array; filename?: string; }>; } | Yes |
put() async
Send a PUT request.
Returns: Promise<T>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
route | string | No | |
options | { body?: unknown; auth?: boolean; } | Yes |
setToken()
Set the bot token for authenticated requests.
Returns: this
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
token | string | null | No |