Class AkairoClient<Ready, Events>

The Akairo framework client. Creates the handlers and sets them up.

Type Parameters

Ready extends boolean = boolean
Events extends AkairoClientEvents = AkairoClientEvents

Hierarchy

Client<Ready, Events>
- AkairoClient

Constructors

constructor

new AkairoClient<
    Ready extends boolean = boolean,
    Events extends AkairoClientEvents = AkairoClientEvents,
>(
    options: AkairoClientOptions & ClientOptions,
): AkairoClient<Ready, Events>
Type Parameters
- Ready extends boolean = boolean
- Events extends AkairoClientEvents = AkairoClientEvents
Parameters
- options: AkairoClientOptions & ClientOptions
  Options for the client.
Returns AkairoClient<Ready, Events>
Overrides Client< Ready, Events >.constructor
- Defined in src/struct/AkairoClient.ts:33
new AkairoClient<
    Ready extends boolean = boolean,
    Events extends AkairoClientEvents = AkairoClientEvents,
>(
    options: AkairoClientOptions,
    clientOptions: ClientOptions,
): AkairoClient<Ready, Events>
Type Parameters
- Ready extends boolean = boolean
- Events extends AkairoClientEvents = AkairoClientEvents
Parameters
- options: AkairoClientOptions
- clientOptions: ClientOptions
Returns AkairoClient<Ready, Events>
Overrides Client< Ready, Events >.constructor
- Defined in src/struct/AkairoClient.ts:34

Properties

`Protected` `Readonly`[brandSymbol]

"[brandSymbol]": Events

This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

application

application: If<Ready, ClientApplication>

The action manager of the client

channels

channels: ChannelManager

All of the BaseChannels that the client is currently handling, mapped by their ids - as long as sharding isn't being used, this will be every channel in every guild the bot is a member of. Note that DM channels will not be initially cached, and thus not be present in the Manager without their explicit fetching or use.

guilds

guilds: GuildManager

All of the guilds the client is currently handling, mapped by their ids - as long as sharding isn't being used, this will be every guild the bot is a member of

lastPingTimestamps

lastPingTimestamps: ReadonlyCollection<number, number>

The last time a ping was sent (a timestamp) for each WebSocketShard connection

options

options: Omit<ClientOptions, "intents"> & { intents: IntentsBitField }

The options the client was instantiated with

ownerID

ownerID: string | string[]

The ID of the owner(s).

readyTimestamp

readyTimestamp: If<Ready, number>

Timestamp of the time the client was last Status.Ready at

rest

rest: REST

The REST manager of the client

shard

shard: null | ShardClientUtil

Shard helpers for the client (only if the process was spawned from a ShardingManager)

status

status: Status

The current status of this Client

superUserID

superUserID: string | string[]

The ID of the superUser(s).

sweepers

sweepers: Sweepers

The sweeping functions and their intervals used to periodically sweep caches

token

token: If<Ready, string, null | string>

Authorization token for the logged in bot. If present, this defaults to process.env.DISCORD_TOKEN when instantiating the client This should be kept private at all times.

user

user: If<Ready, ClientUser>

User that the client is logged in as

users

users: UserManager

All of the User objects that have been cached at any point, mapped by their ids

util

util: ClientUtil

Utility methods.

voice

voice: ClientVoiceManager

The voice manager of the client

ws

ws: WebSocketManager

The WebSocket manager of the client

Accessors

ping

get ping(): null | number
The average ping of all WebSocketShards

Returns null | number
Inherited from Client.ping
- Defined in node_modules/discord.js/typings/index.d.ts:2641

readyAt

get readyAt(): If<Ready, Date>
Time at which the client was last regarded as being in the Status.Ready state (each time the client disconnects and successfully reconnects, this will be overwritten)

Returns If<Ready, Date>
Inherited from Client.readyAt
- Defined in node_modules/discord.js/typings/index.d.ts:2647

uptime

get uptime(): If<Ready, number>
How long it has been since the client last entered the Status.Ready state in milliseconds

Returns If<Ready, number>
Inherited from Client.uptime
- Defined in node_modules/discord.js/typings/index.d.ts:2679

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Inherited from Client.[asyncDispose]
- Defined in node_modules/discord.js/typings/index.d.ts:1247

addListener

addListener<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

deleteWebhook

deleteWebhook(id: string, options?: WebhookDeleteOptions): Promise<void>
Deletes a webhook.
Parameters
- id: string
  The webhook's id
- Optionaloptions: WebhookDeleteOptions
  Options for deleting the webhook
Returns Promise<void>
Inherited from Client.deleteWebhook
- Defined in node_modules/discord.js/typings/index.d.ts:2711

destroy

destroy(): Promise<void>
Logs out, terminates the connection to Discord, and destroys the client.

Returns Promise<void>
Inherited from Client.destroy
- Defined in node_modules/discord.js/typings/index.d.ts:2704

emit

emit<K extends string | number | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<Events>,
        K,
    >,
): boolean
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>
Returns boolean
Inherited from Client.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit<K extends string | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<Events>,
        K,
    >,
): boolean
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>
Returns boolean
Inherited from Client.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38

eventNames

eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof Events
)[]
Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof Events
)[]
Inherited from Client.eventNames
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45

fetchDefaultSoundboardSounds

fetchDefaultSoundboardSounds(): Promise<
Collection<string, DefaultSoundboardSound>,
>
Obtains the list of default soundboard sounds.

Returns Promise<Collection<string, DefaultSoundboardSound>>
Example
```
client.fetchDefaultSoundboardSounds()
 .then(sounds => console.log(`Available soundboard sounds are: ${sounds.map(sound => sound.name).join(', ')}`))
 .catch(console.error);
```
Inherited from Client.fetchDefaultSoundboardSounds
- Defined in node_modules/discord.js/typings/index.d.ts:2783

fetchGuildPreview

fetchGuildPreview(guild: GuildResolvable): Promise<GuildPreview>
Obtains a guild preview from Discord, available for all guilds the bot is in and all Discoverable guilds.
Parameters
- guild: GuildResolvable
  The guild to fetch the preview for
Returns Promise<GuildPreview>
Inherited from Client.fetchGuildPreview
- Defined in node_modules/discord.js/typings/index.d.ts:2717

fetchGuildTemplate

fetchGuildTemplate(template: string): Promise<GuildTemplate>
Obtains a template from Discord.
Parameters
- template: string
  Template code or URL
Returns Promise<GuildTemplate>
Example
```
client.fetchGuildTemplate('https://discord.new/FKvmczH2HyUf')
  .then(template => console.log(`Obtained template with code: ${template.code}`))
  .catch(console.error);
```
Inherited from Client.fetchGuildTemplate
- Defined in node_modules/discord.js/typings/index.d.ts:2738

fetchGuildWidget

fetchGuildWidget(guild: GuildResolvable): Promise<Widget>
Obtains the widget data of a guild from Discord, available for guilds with the widget enabled.
Parameters
- guild: GuildResolvable
  The guild to fetch the widget data for
Returns Promise<Widget>
Inherited from Client.fetchGuildWidget
- Defined in node_modules/discord.js/typings/index.d.ts:2800

fetchInvite

fetchInvite(invite: string, options?: ClientFetchInviteOptions): Promise<Invite>
Obtains an invite from Discord.
Parameters
- invite: string
  Invite code or URL
- Optionaloptions: ClientFetchInviteOptions
  Options for fetching the invite
Returns Promise<Invite>
Example
```
client.fetchInvite('https://discord.gg/djs')
  .then(invite => console.log(`Obtained invite with code: ${invite.code}`))
  .catch(console.error);
```
Inherited from Client.fetchInvite
- Defined in node_modules/discord.js/typings/index.d.ts:2728

fetchSticker

fetchSticker(id: string): Promise<Sticker>
Obtains a sticker from Discord.
Parameters
- id: string
  The sticker's id
Returns Promise<Sticker>
Example
```
client.fetchSticker('id')
  .then(sticker => console.log(`Obtained sticker with name: ${sticker.name}`))
  .catch(console.error);
```
Inherited from Client.fetchSticker
- Defined in node_modules/discord.js/typings/index.d.ts:2757

fetchStickerPacks

fetchStickerPacks(options?: { packId: string }): Promise<StickerPack>
Obtains the list of available sticker packs.
Parameters
- Optionaloptions: { packId: string }
  Options for fetching sticker packs A collection of sticker packs, or a single sticker pack if a packId was provided
Returns Promise<StickerPack>
Example
```
client.fetchStickerPacks()
  .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
  .catch(console.error);
```
Example
```
client.fetchStickerPacks({ packId: '751604115435421716' })
  .then(pack => console.log(`Sticker pack name: ${pack.name}`))
  .catch(console.error);
```
Inherited from Client.fetchStickerPacks
- Defined in node_modules/discord.js/typings/index.d.ts:2772
fetchStickerPacks(
options?: StickerPackFetchOptions,
): Promise<Collection<string, StickerPack>>
Obtains the list of available sticker packs.
Parameters
- Optionaloptions: StickerPackFetchOptions
  Options for fetching sticker packs A collection of sticker packs, or a single sticker pack if a packId was provided
Returns Promise<Collection<string, StickerPack>>
Example
```
client.fetchStickerPacks()
  .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
  .catch(console.error);
```
Example
```
client.fetchStickerPacks({ packId: '751604115435421716' })
  .then(pack => console.log(`Sticker pack name: ${pack.name}`))
  .catch(console.error);
```
Inherited from Client.fetchStickerPacks
- Defined in node_modules/discord.js/typings/index.d.ts:2773

fetchVoiceRegions

fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>
Obtains the available voice regions from Discord.

Returns Promise<Collection<string, VoiceRegion>>
Example
```
client.fetchVoiceRegions()
  .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))
  .catch(console.error);
```
Inherited from Client.fetchVoiceRegions
- Defined in node_modules/discord.js/typings/index.d.ts:2747

fetchWebhook

fetchWebhook(id: string, token?: string): Promise<Webhook<WebhookType>>
Obtains a webhook from Discord.
Parameters
- id: string
  The webhook's id
- Optionaltoken: string
  Token for the webhook
Returns Promise<Webhook<WebhookType>>
Example
```
client.fetchWebhook('id', 'token')
  .then(webhook => console.log(`Obtained webhook with name: ${webhook.name}`))
  .catch(console.error);
```
Inherited from Client.fetchWebhook
- Defined in node_modules/discord.js/typings/index.d.ts:2794

generateInvite

generateInvite(options?: InviteGenerationOptions): string

Generates a link that can be used to invite the bot to a guild.

Parameters

Optionaloptions: InviteGenerationOptions
Options for the invite

Returns string

Example

const link = client.generateInvite({
  scopes: ['applications.commands'],
});
console.log(`Generated application invite link: ${link}`);

Example

const link = client.generateInvite({
  permissions: [
    PermissionFlagsBits.SendMessages,
    PermissionFlagsBits.ManageGuild,
    PermissionFlagsBits.MentionEveryone,
  ],
  scopes: ['bot'],
});
console.log(`Generated bot invite link: ${link}`);

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Client.getMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32

isOwner

isOwner(user: UserResolvable): boolean
Checks if a user is the owner of this bot.
Parameters
- user: UserResolvable
  User to check.
Returns boolean
- Defined in src/struct/AkairoClient.ts:48

isReady

isReady(): this is Client<true, ClientEventTypes>
Returns whether the client has logged in, indicative of being able to access properties such as user and application.

Returns this is Client<true, ClientEventTypes>
Inherited from Client.isReady
- Defined in node_modules/discord.js/typings/index.d.ts:2836

isSuperUser

isSuperUser(user: UserResolvable): boolean
Checks if a user is a super user of this bot.
Parameters
- user: UserResolvable
  User to check.
Returns boolean
- Defined in src/struct/AkairoClient.ts:58

listenerCount

listenerCount<K extends string | number | symbol>(eventName: K): number
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName: string | symbol): number
Parameters
- eventName: string | symbol
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40

listeners

listeners<K extends string | number | symbol>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Inherited from Client.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners<K extends string | symbol>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<Events>,
        K,
        Events,
    >["listener"],
    undefined,
>[]
Inherited from Client.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34

login(token?: string): Promise<string>
Logs the client in, establishing a WebSocket connection to Discord.
Parameters
- Optionaltoken: string
  Token of the account to log in with
Returns Promise<string>
Token of the account used
Example
```
client.login('my token');
```
Inherited from Client.login
- Defined in node_modules/discord.js/typings/index.d.ts:2830

off

off<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26

on

on<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

once

once<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

prependListener

prependListener<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42

prependOnceListener

prependOnceListener<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44

rawListeners

rawListeners<K extends string | number | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Inherited from Client.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners<K extends string | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<Events>,
    K,
    Events,
>[]
Inherited from Client.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36

removeAllListeners

removeAllListeners<K extends string | number | symbol>(event: K): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
Returns this
Inherited from Client.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners<K extends string | number | symbol>(event?: K): this
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalevent: K
Returns this
Inherited from Client.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event: string | symbol): this
Parameters
- event: string | symbol
Returns this
Inherited from Client.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event?: string | symbol): this
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from Client.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:30

removeListener

removeListener<K extends string | number | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<Events>,
            K,
            Events,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >["listener"],
      undefined,
  >
Returns this
Inherited from Client.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from Client.setMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31

toJSON

toJSON(): unknown
Transforms the client into a plain object.

Returns unknown
Inherited from Client.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:2841

waitForAllListenersToComplete

waitForAllListenersToComplete(): Promise<boolean>
Returns Promise<boolean>
Inherited from Client.waitForAllListenersToComplete
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:46

`Static`listenerCount

listenerCount<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
): number
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(
emitter: AsyncEventEmitter<any>,
eventName: string | symbol,
): number
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:50

`Static`on

on<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Inherited from Client.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
on(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): AsyncGenerator<any[], void>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<any[], void>
Inherited from Client.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54

`Static`once

once<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Inherited from Client.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): Promise<any[]>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns Promise<any[]>
Inherited from Client.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52

Class AkairoClient<Ready, Events>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AkairoClient<Ready, Events>

Type Parameters

Parameters

Returns AkairoClient<Ready, Events>

Properties

Protected Readonly[brandSymbol]

application

channels

guilds

lastPingTimestamps

options

ownerID

readyTimestamp

rest

shard

status

superUserID

sweepers

token

user

users

util

voice

ws

Accessors

ping

Returns null | number

readyAt

Returns If<Ready, Date>

uptime

Returns If<Ready, number>

Methods

[asyncDispose]

Returns Promise<void>

addListener

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

deleteWebhook

Parameters

Returns Promise<void>

destroy

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & ( keyof Events)[]

fetchDefaultSoundboardSounds

Returns Promise<Collection<string, DefaultSoundboardSound>>

Example

fetchGuildPreview

Parameters

Returns Promise<GuildPreview>

fetchGuildTemplate

Parameters

Returns Promise<GuildTemplate>

Example

fetchGuildWidget

Parameters

Returns Promise<Widget>

`Protected` `Readonly`[brandSymbol]

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof Events
)[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<Events>,
K,
Events,
>["listener"],
undefined,
>[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<Events>,
K,
Events,
>["listener"],
undefined,
>[]