BotClient

Vocality Documentation › Globals › BotClient

Hierarchy

• Client

  ↳ BotClient

Implements

• Client

Index

Constructors

• constructor

Properties

• channels
• coreCommands
• customCommands
• emojis
• guilds
• messageHandler
• options
• opts
• pluginController
• readyAt
• readyTimestamp
• shard
• token
• uptime
• user
• users
• voice
• ws
• botInstance

Methods

• addCommand
• addCustomListener
• addListener
• addPlugin
• clearImmediate
• clearInterval
• clearTimeout
• createMessage
• destroy
• emit
• emitCustomEvent
• eventNames
• fetchApplication
• fetchInvite
• fetchVoiceRegions
• fetchWebhook
• findCommand
• findGuild
• generateInvite
• getAllCommands
• getMaxListeners
• init
• input
• listenerCount
• listeners
• loadPluginFromOptions
• login
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeCommand
• removeListener
• setImmediate
• setInterval
• setMaxListeners
• setTimeout
• sweepMessages
• toJSON
• instance

Constructors

Private constructor

+ new BotClient(options?: ClientOptions): BotClient

Overrides void

Defined in packages/vocality-core/src/bot/BotClient.ts:40

Parameters:

Name	Type
options?	ClientOptions

Returns: BotClient

Properties

channels

• channels: ChannelStore

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:154

---

Private coreCommands

• coreCommands: Command[] = []

Defined in packages/vocality-core/src/bot/BotClient.ts:27

All the core commands are stored here. Core commands are globally enabled across all guilds.

---

Private customCommands

• customCommands: Command[] = []

Defined in packages/vocality-core/src/bot/BotClient.ts:34

Only commands added with the addCommand method are stored here. The commands are like coreCommands globally available across all guilds and can not be disabled. Only by removing them with the removeCommand method.

---

emojis

• emojis: GuildEmojiStore

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:155

---

guilds

• guilds: GuildStore

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:156

---

Private messageHandler

• messageHandler: MessageHandler

Defined in packages/vocality-core/src/bot/BotClient.ts:37

---

options

• options: ClientOptions

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:98

---

opts

• opts: ClientOptions | undefined

Defined in packages/vocality-core/src/bot/BotClient.ts:40

---

pluginController

• pluginController: PluginController

Defined in packages/vocality-core/src/bot/BotClient.ts:39

---

readyAt

• readyAt: Date | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:157

---

readyTimestamp

• readyTimestamp: number | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:158

---

shard

• shard: ShardClientUtil | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:159

---

token

• token: string | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:160

---

uptime

• uptime: number | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:161

---

user

• user: ClientUser | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:162

---

users

• users: UserStore

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:163

---

voice

• voice: ClientVoiceManager | null

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:164

---

ws

• ws: WebSocketManager

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:165

---

Static Private botInstance

▪ botInstance: BotClient | undefined

Defined in packages/vocality-core/src/bot/BotClient.ts:36

Methods

addCommand

▸ addCommand(command: Command): void

Defined in packages/vocality-core/src/bot/BotClient.ts:158

Parameters:

Name	Type
command	Command

Returns: void

---

addCustomListener

▸ addCustomListener(event: string, callback: Function): void

Defined in packages/vocality-core/src/bot/BotClient.ts:72

Parameters:

Name	Type
event	string
callback	Function

Returns: void

---

addListener

▸ addListener(event: string | symbol, listener: function): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:541

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

addPlugin

▸ addPlugin(plugin: Plugin, loaded: boolean): void

Defined in packages/vocality-core/src/bot/BotClient.ts:172

Parameters:

Name	Type
plugin	Plugin
loaded	boolean

Returns: void

---

clearImmediate

▸ clearImmediate(timeout: Immediate): void

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:101

Parameters:

Name	Type
timeout	Immediate

Returns: void

---

clearInterval

▸ clearInterval(interval: Timer): void

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:99

Parameters:

Name	Type
interval	Timer

Returns: void

---

clearTimeout

▸ clearTimeout(timeout: Timer): void

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:100

Parameters:

Name	Type
timeout	Timer

Returns: void

---

Private createMessage

▸ createMessage(guildId: string): Message‹›

Defined in packages/vocality-core/src/bot/BotClient.ts:189

Parameters:

Name	Type
guildId	string

Returns: Message‹›

---

destroy

▸ destroy(): void

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:166

Returns: void

---

emit

▸ emit(event: string | symbol, ...args: any[]): boolean

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:551

Parameters:

Name	Type
event	string | symbol
...args	any[]

Returns: boolean

---

emitCustomEvent

▸ emitCustomEvent(event: string, ...args: any[]): void

Defined in packages/vocality-core/src/bot/BotClient.ts:154

Parameters:

Name	Type
event	string
...args	any[]

Returns: void

---

eventNames

▸ eventNames(): Array‹string | symbol›

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:556

Returns: Array‹string | symbol›

---

fetchApplication

▸ fetchApplication(): Promise‹ClientApplication›

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:167

Returns: Promise‹ClientApplication›

---

fetchInvite

▸ fetchInvite(invite: InviteResolvable): Promise‹Invite›

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:168

Parameters:

Name	Type
invite	InviteResolvable

Returns: Promise‹Invite›

---

fetchVoiceRegions

▸ fetchVoiceRegions(): Promise‹Collection‹string, VoiceRegion››

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:169

Returns: Promise‹Collection‹string, VoiceRegion››

---

fetchWebhook

▸ fetchWebhook(id: Snowflake, token?: undefined | string): Promise‹Webhook›

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:170

Parameters:

Name	Type
id	Snowflake
token?	undefined | string

Returns: Promise‹Webhook›

---

findCommand

▸ findCommand(guildId: string, search: string): CommandSearchResult | CommandSearchResult[] | undefined

Defined in packages/vocality-core/src/bot/BotClient.ts:104

Parameters:

Name	Type
guildId	string
search	string

Returns: CommandSearchResult | CommandSearchResult[] | undefined

---

findGuild

▸ findGuild(guildId: string): Guild | undefined

Defined in packages/vocality-core/src/bot/BotClient.ts:150

Parameters:

Name	Type
guildId	string

Returns: Guild | undefined

---

generateInvite

▸ generateInvite(permissions?: PermissionResolvable): Promise‹string›

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:171

Parameters:

Name	Type
permissions?	PermissionResolvable

Returns: Promise‹string›

---

getAllCommands

▸ getAllCommands(guildId: string): CommandSearchResult[]

Defined in packages/vocality-core/src/bot/BotClient.ts:76

Parameters:

Name	Type
guildId	string

Returns: CommandSearchResult[]

---

getMaxListeners

▸ getMaxListeners(): number

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:548

Returns: number

---

init

▸ init(token?: undefined | string): Promise‹void›

Defined in packages/vocality-core/src/bot/BotClient.ts:218

Used to login the Bot with the Discord Token

Parameters:

Name	Type
token?	undefined | string

Returns: Promise‹void›

---

input

▸ input(guildId: string, message: string): void

Defined in packages/vocality-core/src/bot/BotClient.ts:183

Process a input message and executes a command if found.

Parameters:

Name	Type	Description
guildId	string	Specifies the guild you want the message to be for
message	string	The content of the message to process

Returns: void

---

listenerCount

▸ listenerCount(type: string | symbol): number

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:552

Parameters:

Name	Type
type	string | symbol

Returns: number

---

listeners

▸ listeners(event: string | symbol): Function[]

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:549

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

Private loadPluginFromOptions

▸ loadPluginFromOptions(): void

Defined in packages/vocality-core/src/bot/BotClient.ts:205

Returns: void

---

login

▸ login(token?: undefined | string): Promise‹string›

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:172

Parameters:

Name	Type
token?	undefined | string

Returns: Promise‹string›

---

off

▸ off(event: string | symbol, listener: function): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:545

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

on

▸ on(event: "channelCreate" | "channelDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:176

Parameters:

▪ event: "channelCreate" | "channelDelete"

▪ listener: function

▸ (channel: Channel | PartialChannel): void

Parameters:

Name	Type
channel	Channel | PartialChannel

Returns: this

▸ on(event: "channelPinsUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:177

Parameters:

▪ event: "channelPinsUpdate"

▪ listener: function

▸ (channel: Channel | PartialChannel, time: Date): void

Parameters:

Name	Type
channel	Channel | PartialChannel
time	Date

Returns: this

▸ on(event: "channelUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:178

Parameters:

▪ event: "channelUpdate"

▪ listener: function

▸ (oldChannel: Channel | PartialChannel, newChannel: Channel | PartialChannel): void

Parameters:

Name	Type
oldChannel	Channel | PartialChannel
newChannel	Channel | PartialChannel

Returns: this

▸ on(event: "debug" | "warn", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:179

Parameters:

▪ event: "debug" | "warn"

▪ listener: function

▸ (info: string): void

Parameters:

Name	Type
info	string

Returns: this

▸ on(event: "disconnect", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:180

Parameters:

▪ event: "disconnect"

▪ listener: function

▸ (event: any, shardID: number): void

Parameters:

Name	Type
event	any
shardID	number

Returns: this

▸ on(event: "emojiCreate" | "emojiDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:181

Parameters:

▪ event: "emojiCreate" | "emojiDelete"

▪ listener: function

▸ (emoji: GuildEmoji): void

Parameters:

Name	Type
emoji	GuildEmoji

Returns: this

▸ on(event: "emojiUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:182

Parameters:

▪ event: "emojiUpdate"

▪ listener: function

▸ (oldEmoji: GuildEmoji, newEmoji: GuildEmoji): void

Parameters:

Name	Type
oldEmoji	GuildEmoji
newEmoji	GuildEmoji

Returns: this

▸ on(event: "error", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:183

Parameters:

▪ event: "error"

▪ listener: function

▸ (error: Error): void

Parameters:

Name	Type
error	Error

Returns: this

▸ on(event: "guildBanAdd" | "guildBanRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:184

Parameters:

▪ event: "guildBanAdd" | "guildBanRemove"

▪ listener: function

▸ (guild: Guild, user: User | PartialUser): void

Parameters:

Name	Type
guild	Guild
user	User | PartialUser

Returns: this

▸ on(event: "guildCreate" | "guildDelete" | "guildUnavailable", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:185

Parameters:

▪ event: "guildCreate" | "guildDelete" | "guildUnavailable"

▪ listener: function

▸ (guild: Guild): void

Parameters:

Name	Type
guild	Guild

Returns: this

▸ on(event: "guildMemberAdd" | "guildMemberAvailable" | "guildMemberRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:186

Parameters:

▪ event: "guildMemberAdd" | "guildMemberAvailable" | "guildMemberRemove"

▪ listener: function

▸ (member: GuildMember | PartialGuildMember): void

Parameters:

Name	Type
member	GuildMember | PartialGuildMember

Returns: this

▸ on(event: "guildMembersChunk", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:187

Parameters:

▪ event: "guildMembersChunk"

▪ listener: function

▸ (members: Collection‹Snowflake, GuildMember | PartialGuildMember›, guild: Guild): void

Parameters:

Name	Type
members	Collection‹Snowflake, GuildMember | PartialGuildMember›
guild	Guild

Returns: this

▸ on(event: "guildMemberSpeaking", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:188

Parameters:

▪ event: "guildMemberSpeaking"

▪ listener: function

▸ (member: GuildMember | PartialGuildMember, speaking: Readonly‹Speaking›): void

Parameters:

Name	Type
member	GuildMember | PartialGuildMember
speaking	Readonly‹Speaking›

Returns: this

▸ on(event: "guildMemberUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:189

Parameters:

▪ event: "guildMemberUpdate"

▪ listener: function

▸ (oldMember: GuildMember | PartialGuildMember, newMember: GuildMember | PartialGuildMember): void

Parameters:

Name	Type
oldMember	GuildMember | PartialGuildMember
newMember	GuildMember | PartialGuildMember

Returns: this

▸ on(event: "guildUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:190

Parameters:

▪ event: "guildUpdate"

▪ listener: function

▸ (oldGuild: Guild, newGuild: Guild): void

Parameters:

Name	Type
oldGuild	Guild
newGuild	Guild

Returns: this

▸ on(event: "inviteCreate" | "inviteDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:191

Parameters:

▪ event: "inviteCreate" | "inviteDelete"

▪ listener: function

▸ (invite: Invite): void

Parameters:

Name	Type
invite	Invite

Returns: this

▸ on(event: "guildIntegrationsUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:192

Parameters:

▪ event: "guildIntegrationsUpdate"

▪ listener: function

▸ (guild: Guild): void

Parameters:

Name	Type
guild	Guild

Returns: this

▸ on(event: "message" | "messageDelete" | "messageReactionRemoveAll", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:193

Parameters:

▪ event: "message" | "messageDelete" | "messageReactionRemoveAll"

▪ listener: function

▸ (message: Message | PartialMessage): void

Parameters:

Name	Type
message	Message | PartialMessage

Returns: this

▸ on(event: "messageReactionRemoveEmoji", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:194

Parameters:

▪ event: "messageReactionRemoveEmoji"

▪ listener: function

▸ (reaction: MessageReaction): void

Parameters:

Name	Type
reaction	MessageReaction

Returns: this

▸ on(event: "messageDeleteBulk", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:195

Parameters:

▪ event: "messageDeleteBulk"

▪ listener: function

▸ (messages: Collection‹Snowflake, Message | PartialMessage›): void

Parameters:

Name	Type
messages	Collection‹Snowflake, Message | PartialMessage›

Returns: this

▸ on(event: "messageReactionAdd" | "messageReactionRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:196

Parameters:

▪ event: "messageReactionAdd" | "messageReactionRemove"

▪ listener: function

▸ (messageReaction: MessageReaction, user: User | PartialUser): void

Parameters:

Name	Type
messageReaction	MessageReaction
user	User | PartialUser

Returns: this

▸ on(event: "messageUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:197

Parameters:

▪ event: "messageUpdate"

▪ listener: function

▸ (oldMessage: Message | PartialMessage, newMessage: Message | PartialMessage): void

Parameters:

Name	Type
oldMessage	Message | PartialMessage
newMessage	Message | PartialMessage

Returns: this

▸ on(event: "presenceUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:198

Parameters:

▪ event: "presenceUpdate"

▪ listener: function

▸ (oldPresence: Presence | undefined, newPresence: Presence): void

Parameters:

Name	Type
oldPresence	Presence | undefined
newPresence	Presence

Returns: this

▸ on(event: "rateLimit", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:199

Parameters:

▪ event: "rateLimit"

▪ listener: function

▸ (rateLimitData: RateLimitData): void

Parameters:

Name	Type
rateLimitData	RateLimitData

Returns: this

▸ on(event: "ready", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:200

Parameters:

▪ event: "ready"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "roleCreate" | "roleDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:201

Parameters:

▪ event: "roleCreate" | "roleDelete"

▪ listener: function

▸ (role: Role): void

Parameters:

Name	Type
role	Role

Returns: this

▸ on(event: "roleUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:202

Parameters:

▪ event: "roleUpdate"

▪ listener: function

▸ (oldRole: Role, newRole: Role): void

Parameters:

Name	Type
oldRole	Role
newRole	Role

Returns: this

▸ on(event: "typingStart" | "typingStop", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:203

Parameters:

▪ event: "typingStart" | "typingStop"

▪ listener: function

▸ (channel: Channel | PartialChannel, user: User | PartialUser): void

Parameters:

Name	Type
channel	Channel | PartialChannel
user	User | PartialUser

Returns: this

▸ on(event: "userUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:204

Parameters:

▪ event: "userUpdate"

▪ listener: function

▸ (oldUser: User | PartialUser, newUser: User | PartialUser): void

Parameters:

Name	Type
oldUser	User | PartialUser
newUser	User | PartialUser

Returns: this

▸ on(event: "voiceStateUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:205

Parameters:

▪ event: "voiceStateUpdate"

▪ listener: function

▸ (oldState: VoiceState, newState: VoiceState): void

Parameters:

Name	Type
oldState	VoiceState
newState	VoiceState

Returns: this

▸ on(event: "webhookUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:206

Parameters:

▪ event: "webhookUpdate"

▪ listener: function

▸ (channel: TextChannel): void

Parameters:

Name	Type
channel	TextChannel

Returns: this

▸ on(event: "invalidated", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:207

Parameters:

▪ event: "invalidated"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "shardDisconnect", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:208

Parameters:

▪ event: "shardDisconnect"

▪ listener: function

▸ (event: CloseEvent, id: number): void

Parameters:

Name	Type
event	CloseEvent
id	number

Returns: this

▸ on(event: "shardError", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:209

Parameters:

▪ event: "shardError"

▪ listener: function

▸ (error: Error, id: number): void

Parameters:

Name	Type
error	Error
id	number

Returns: this

▸ on(event: "shardReconnecting", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:210

Parameters:

▪ event: "shardReconnecting"

▪ listener: function

▸ (id: number): void

Parameters:

Name	Type
id	number

Returns: this

▸ on(event: "shardReady", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:211

Parameters:

▪ event: "shardReady"

▪ listener: function

▸ (id: number): void

Parameters:

Name	Type
id	number

Returns: this

▸ on(event: "shardResume", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:212

Parameters:

▪ event: "shardResume"

▪ listener: function

▸ (id: number, replayed: number): void

Parameters:

Name	Type
id	number
replayed	number

Returns: this

▸ on(event: string, listener: Function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:213

Parameters:

Name	Type
event	string
listener	Function

Returns: this

---

once

▸ once(event: "channelCreate" | "channelDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:215

Parameters:

▪ event: "channelCreate" | "channelDelete"

▪ listener: function

▸ (channel: Channel | PartialChannel): void

Parameters:

Name	Type
channel	Channel | PartialChannel

Returns: this

▸ once(event: "channelPinsUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:216

Parameters:

▪ event: "channelPinsUpdate"

▪ listener: function

▸ (channel: Channel | PartialChannel, time: Date): void

Parameters:

Name	Type
channel	Channel | PartialChannel
time	Date

Returns: this

▸ once(event: "channelUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:217

Parameters:

▪ event: "channelUpdate"

▪ listener: function

▸ (oldChannel: Channel | PartialChannel, newChannel: Channel | PartialChannel): void

Parameters:

Name	Type
oldChannel	Channel | PartialChannel
newChannel	Channel | PartialChannel

Returns: this

▸ once(event: "debug" | "warn", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:218

Parameters:

▪ event: "debug" | "warn"

▪ listener: function

▸ (info: string): void

Parameters:

Name	Type
info	string

Returns: this

▸ once(event: "disconnect", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:219

Parameters:

▪ event: "disconnect"

▪ listener: function

▸ (event: any, shardID: number): void

Parameters:

Name	Type
event	any
shardID	number

Returns: this

▸ once(event: "emojiCreate" | "emojiDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:220

Parameters:

▪ event: "emojiCreate" | "emojiDelete"

▪ listener: function

▸ (emoji: GuildEmoji): void

Parameters:

Name	Type
emoji	GuildEmoji

Returns: this

▸ once(event: "emojiUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:221

Parameters:

▪ event: "emojiUpdate"

▪ listener: function

▸ (oldEmoji: GuildEmoji, newEmoji: GuildEmoji): void

Parameters:

Name	Type
oldEmoji	GuildEmoji
newEmoji	GuildEmoji

Returns: this

▸ once(event: "error", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:222

Parameters:

▪ event: "error"

▪ listener: function

▸ (error: Error): void

Parameters:

Name	Type
error	Error

Returns: this

▸ once(event: "guildBanAdd" | "guildBanRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:223

Parameters:

▪ event: "guildBanAdd" | "guildBanRemove"

▪ listener: function

▸ (guild: Guild, user: User | PartialUser): void

Parameters:

Name	Type
guild	Guild
user	User | PartialUser

Returns: this

▸ once(event: "guildCreate" | "guildDelete" | "guildUnavailable", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:224

Parameters:

▪ event: "guildCreate" | "guildDelete" | "guildUnavailable"

▪ listener: function

▸ (guild: Guild): void

Parameters:

Name	Type
guild	Guild

Returns: this

▸ once(event: "guildMemberAdd" | "guildMemberAvailable" | "guildMemberRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:225

Parameters:

▪ event: "guildMemberAdd" | "guildMemberAvailable" | "guildMemberRemove"

▪ listener: function

▸ (member: GuildMember | PartialGuildMember): void

Parameters:

Name	Type
member	GuildMember | PartialGuildMember

Returns: this

▸ once(event: "guildMembersChunk", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:226

Parameters:

▪ event: "guildMembersChunk"

▪ listener: function

▸ (members: Collection‹Snowflake, GuildMember | PartialGuildMember›, guild: Guild): void

Parameters:

Name	Type
members	Collection‹Snowflake, GuildMember | PartialGuildMember›
guild	Guild

Returns: this

▸ once(event: "guildMemberSpeaking", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:227

Parameters:

▪ event: "guildMemberSpeaking"

▪ listener: function

▸ (member: GuildMember | PartialGuildMember, speaking: Readonly‹Speaking›): void

Parameters:

Name	Type
member	GuildMember | PartialGuildMember
speaking	Readonly‹Speaking›

Returns: this

▸ once(event: "guildMemberUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:228

Parameters:

▪ event: "guildMemberUpdate"

▪ listener: function

▸ (oldMember: GuildMember | PartialGuildMember, newMember: GuildMember | PartialGuildMember): void

Parameters:

Name	Type
oldMember	GuildMember | PartialGuildMember
newMember	GuildMember | PartialGuildMember

Returns: this

▸ once(event: "guildUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:229

Parameters:

▪ event: "guildUpdate"

▪ listener: function

▸ (oldGuild: Guild, newGuild: Guild): void

Parameters:

Name	Type
oldGuild	Guild
newGuild	Guild

Returns: this

▸ once(event: "guildIntegrationsUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:230

Parameters:

▪ event: "guildIntegrationsUpdate"

▪ listener: function

▸ (guild: Guild): void

Parameters:

Name	Type
guild	Guild

Returns: this

▸ once(event: "message" | "messageDelete" | "messageReactionRemoveAll", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:231

Parameters:

▪ event: "message" | "messageDelete" | "messageReactionRemoveAll"

▪ listener: function

▸ (message: Message | PartialMessage): void

Parameters:

Name	Type
message	Message | PartialMessage

Returns: this

▸ once(event: "messageDeleteBulk", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:232

Parameters:

▪ event: "messageDeleteBulk"

▪ listener: function

▸ (messages: Collection‹Snowflake, Message | PartialMessage›): void

Parameters:

Name	Type
messages	Collection‹Snowflake, Message | PartialMessage›

Returns: this

▸ once(event: "messageReactionAdd" | "messageReactionRemove", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:233

Parameters:

▪ event: "messageReactionAdd" | "messageReactionRemove"

▪ listener: function

▸ (messageReaction: MessageReaction, user: User | PartialUser): void

Parameters:

Name	Type
messageReaction	MessageReaction
user	User | PartialUser

Returns: this

▸ once(event: "messageUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:234

Parameters:

▪ event: "messageUpdate"

▪ listener: function

▸ (oldMessage: Message | PartialMessage, newMessage: Message | PartialMessage): void

Parameters:

Name	Type
oldMessage	Message | PartialMessage
newMessage	Message | PartialMessage

Returns: this

▸ once(event: "presenceUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:235

Parameters:

▪ event: "presenceUpdate"

▪ listener: function

▸ (oldPresence: Presence | undefined, newPresence: Presence): void

Parameters:

Name	Type
oldPresence	Presence | undefined
newPresence	Presence

Returns: this

▸ once(event: "rateLimit", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:236

Parameters:

▪ event: "rateLimit"

▪ listener: function

▸ (rateLimitData: RateLimitData): void

Parameters:

Name	Type
rateLimitData	RateLimitData

Returns: this

▸ once(event: "ready", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:237

Parameters:

▪ event: "ready"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "roleCreate" | "roleDelete", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:238

Parameters:

▪ event: "roleCreate" | "roleDelete"

▪ listener: function

▸ (role: Role): void

Parameters:

Name	Type
role	Role

Returns: this

▸ once(event: "roleUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:239

Parameters:

▪ event: "roleUpdate"

▪ listener: function

▸ (oldRole: Role, newRole: Role): void

Parameters:

Name	Type
oldRole	Role
newRole	Role

Returns: this

▸ once(event: "typingStart" | "typingStop", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:240

Parameters:

▪ event: "typingStart" | "typingStop"

▪ listener: function

▸ (channel: Channel | PartialChannel, user: User | PartialUser): void

Parameters:

Name	Type
channel	Channel | PartialChannel
user	User | PartialUser

Returns: this

▸ once(event: "userUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:241

Parameters:

▪ event: "userUpdate"

▪ listener: function

▸ (oldUser: User | PartialUser, newUser: User | PartialUser): void

Parameters:

Name	Type
oldUser	User | PartialUser
newUser	User | PartialUser

Returns: this

▸ once(event: "voiceStateUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:242

Parameters:

▪ event: "voiceStateUpdate"

▪ listener: function

▸ (oldState: VoiceState, newState: VoiceState): void

Parameters:

Name	Type
oldState	VoiceState
newState	VoiceState

Returns: this

▸ once(event: "webhookUpdate", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:243

Parameters:

▪ event: "webhookUpdate"

▪ listener: function

▸ (channel: TextChannel): void

Parameters:

Name	Type
channel	TextChannel

Returns: this

▸ once(event: "invalidated", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:244

Parameters:

▪ event: "invalidated"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "shardDisconnect", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:245

Parameters:

▪ event: "shardDisconnect"

▪ listener: function

▸ (event: CloseEvent, id: number): void

Parameters:

Name	Type
event	CloseEvent
id	number

Returns: this

▸ once(event: "shardError", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:246

Parameters:

▪ event: "shardError"

▪ listener: function

▸ (error: Error, id: number): void

Parameters:

Name	Type
error	Error
id	number

Returns: this

▸ once(event: "shardReconnecting", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:247

Parameters:

▪ event: "shardReconnecting"

▪ listener: function

▸ (id: number): void

Parameters:

Name	Type
id	number

Returns: this

▸ once(event: "shardReady", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:248

Parameters:

▪ event: "shardReady"

▪ listener: function

▸ (id: number): void

Parameters:

Name	Type
id	number

Returns: this

▸ once(event: "shardResume", listener: function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:249

Parameters:

▪ event: "shardResume"

▪ listener: function

▸ (id: number, replayed: number): void

Parameters:

Name	Type
id	number
replayed	number

Returns: this

▸ once(event: string, listener: Function): this

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:250

Parameters:

Name	Type
event	string
listener	Function

Returns: this

---

prependListener

▸ prependListener(event: string | symbol, listener: function): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:554

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

prependOnceListener

▸ prependOnceListener(event: string | symbol, listener: function): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:555

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

rawListeners

▸ rawListeners(event: string | symbol): Function[]

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:550

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

removeAllListeners

▸ removeAllListeners(event?: string | symbol): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:546

Parameters:

Name	Type
event?	string | symbol

Returns: this

---

removeCommand

▸ removeCommand(command: Command | string): void

Defined in packages/vocality-core/src/bot/BotClient.ts:162

Parameters:

Name	Type
command	Command | string

Returns: void

---

removeListener

▸ removeListener(event: string | symbol, listener: function): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:544

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

setImmediate

▸ setImmediate(fn: Function, ...args: any[]): Immediate

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:105

Parameters:

Name	Type
fn	Function
...args	any[]

Returns: Immediate

---

setInterval

▸ setInterval(fn: Function, delay: number, ...args: any[]): Timer

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:103

Parameters:

Name	Type
fn	Function
delay	number
...args	any[]

Returns: Timer

---

setMaxListeners

▸ setMaxListeners(n: number): this

Inherited from void

Defined in node_modules/@types/node/globals.d.ts:547

Parameters:

Name	Type
n	number

Returns: this

---

setTimeout

▸ setTimeout(fn: Function, delay: number, ...args: any[]): Timer

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:104

Parameters:

Name	Type
fn	Function
delay	number
...args	any[]

Returns: Timer

---

sweepMessages

▸ sweepMessages(lifetime?: undefined | number): number

Inherited from void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:173

Parameters:

Name	Type
lifetime?	undefined | number

Returns: number

---

toJSON

▸ toJSON(): object

Inherited from void

Overrides void

Defined in packages/vocality-types/node_modules/discord.js/typings/index.d.ts:174

Returns: object

---

Static instance

▸ instance(options?: ClientOptions): BotClient

Defined in packages/vocality-core/src/bot/BotClient.ts:57

Parameters:

Name	Type
options?	ClientOptions

Returns: BotClient