Class RESTClient

Utility class for easy HTTP requests to the Discord API. Can be used for other APIs if needed.

Hierarchy

RESTClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RESTClient(options: RESTClientOptions): RESTClient

- Defined in src/rest/RESTClient.ts:24
Parameters
- options: RESTClientOptions
Returns RESTClient

Properties

baseUrl

baseUrl: string

options

options: RESTClientOptions

Optional version

version?: number

API version to add to the RESTClient.baseUrl. Leave empty to not add a version at all.

Methods

createHeaders

createHeaders(request: APIRequest<any>): Record<string, string>

- Defined in src/rest/RESTClient.ts:60
Parameters
- request: APIRequest<any>
Returns Record<string, string>

createURL

createURL(request: APIRequest<any>): string

- Defined in src/rest/RESTClient.ts:153
Parameters
- request: APIRequest<any>
Returns string

execute

execute(request: APIRequest<any>, tracefunc?: any): Promise<ResponseData>

- Defined in src/rest/RESTClient.ts:166
Parameters
- request: APIRequest<any>
- Optional tracefunc: any
Returns Promise<ResponseData>

formatRoute

formatRoute(route: `/${string}`, versioned?: boolean, useBase?: boolean): string

- Defined in src/rest/RESTClient.ts:76
Parameters
- route: `/${string}`
- versioned: boolean = true
- useBase: boolean = true
Returns string

resolveBody

resolveBody(req: APIRequest<any>): APIRequest<any>

- Defined in src/rest/RESTClient.ts:89
Parameters
- req: APIRequest<any>
Returns APIRequest<any>

Static createRESTOptions

createRESTOptions(clientOptions: ClientOptions, token: string, tokenType: "Bot" | "Bearer"): RESTClientOptions

- Defined in src/rest/RESTClient.ts:36
Parameters
- clientOptions: ClientOptions
- token: string
- tokenType: "Bot" | "Bearer"
Returns RESTClientOptions

Static getDefaultOptions

getDefaultOptions(token: string): Required<RESTClientOptions>

- Defined in src/rest/RESTClient.ts:50
Parameters
- token: string
Returns Required<RESTClientOptions>

Generated using TypeDoc