Class DiscordGuilds

Represents a class for interacting with Discord guilds.

Hierarchy (view full)

BaseRoot
- DiscordGuilds

Index

Constructors

Properties

Methods

get getApiKeys makeRequest

Constructors

constructor

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

Properties

client

client: Client

The client used to make requests.

Methods

get

get(id?): Promise<any>
Retrieves information about a Discord guild.
Parameters
- Optional id: string = "949096817050648636"
  The ID of the guild. Defaults to "949096817050648636" which represents the current user's guild.
Returns Promise<any>
- A promise that resolves with the guild information.
- Defined in src/v2/discord/guilds.ts:27

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