Class DiscordUsers

Represents a class for interacting with Discord users.

Hierarchy (view full)

BaseRoot
- DiscordUsers

Index

Constructors

Properties

Methods

avatar banner get getApiKeys makeRequest

Constructors

constructor

new DiscordUsers(client): DiscordUsers
Creates an instance of DiscordUsers.
Parameters
- client: Client
  The client object.
Returns DiscordUsers
Overrides BaseRoot.constructor
- Defined in src/v2/discord/users.ts:13

Properties

client

client: Client

The client used to make requests.

Methods

avatar

avatar(username?): Promise<any>
Retrieves the avatar of a Discord user.
Parameters
- Optional username: string = "@me"
  The username of the user. Defaults to the current user.
Returns Promise<any>
- A promise that resolves with the avatar image.
- Defined in src/v2/discord/users.ts:33

banner

banner(username?): Promise<any>
Retrieves the banner of a Discord user.
Parameters
- Optional username: string = "@me"
  The username of the user. Defaults to the current user.
Returns Promise<any>
- A promise that resolves with the banner image.
- Defined in src/v2/discord/users.ts:43

get

get(id?): Promise<any>
Retrieves information about a Discord user.
Parameters
- Optional id: string = "@me"
  The ID of the user. Defaults to the current user.
Returns Promise<any>
- A promise that resolves with the user information.
- Defined in src/v2/discord/users.ts:24

getApiKeys

getApiKeys(): ApiKeys
Gets the API keys.

Returns ApiKeys
The API keys.
Inherited from BaseRoot.getApiKeys
- Defined in src/BaseRoot.ts:26

makeRequest

makeRequest(endpoint, data?): Promise<any>
Makes an HTTP request to the specified endpoint.
Parameters
- endpoint: string
  The endpoint to make the request to.
- Optional data: any
  The data to send with the request (optional).
Returns Promise<any>
A Promise that resolves to the response data.

Throws
If the request fails.
Inherited from BaseRoot.makeRequest
- Defined in src/Requester.ts:24

Generated using TypeDoc