Class default

Hierarchy

Client
- default

Index

Constructors

constructor

Constructors

constructor

new default(options?: ClientOptions): default
Parameters
- Optional options: ClientOptions
Returns default
Inherited from Client.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:196

Properties

config

config: DiscordBotConfig

type

type: string = 'generic'

discordBotsDbGateway

discordBotsDbGateway: DiscordBotsDbGateway

dmChannelsDbGateway

dmChannelsDbGateway: DmChannelsDbGateway

guildCommands

guildCommands: Map<string, Command> = ...

dmCommands

dmCommands: Map<string, Command> = ...

isConfigured

isConfigured: boolean = false

status

status: DiscordBotStatus = 'disconnected'

botInstanceId

botInstanceId: SUUID = ...

messageProcessingVerifier

messageProcessingVerifier: MessageVerificationScheduler

channels

channels: ChannelManager

`Readonly` emojis

emojis: GuildEmojiManager

guilds

guilds: GuildManager

readyAt

readyAt: null | Date

`Readonly` readyTimestamp

readyTimestamp: null | number

shard

shard: null | ShardClientUtil

token

token: null | string

`Readonly` uptime

uptime: null | number

user

user: null | ClientUser

users

users: UserManager

voice

voice: null | ClientVoiceManager

ws

ws: WebSocketManager

options

options: ClientOptions

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:55

updateStatus

updateStatus(status: DiscordBotStatus): Promise<void>
Parameters
- status: DiscordBotStatus
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:85

`Private` attemptToBecomeListener

attemptToBecomeListener(listenerId?: null | SUUID): Promise<boolean>
Parameters
- Optional listenerId: null | SUUID
Returns Promise<boolean>
- Defined in packages/discord-bot/bot.ts:91

`Private` listenForDatabaseNotifications

listenForDatabaseNotifications(): Promise<void>
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:100

notifyMessageProcessed

notifyMessageProcessed(message: Message): Promise<void>
Parameters
- message: Message
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:109

handleBotStatusUpdate

handleBotStatusUpdate(_payload: any): Promise<void>
Parameters
- _payload: any
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:113

handleBotMessageProcessing

handleBotMessageProcessing(payload: any): void
Parameters
- payload: any
Returns void
- Defined in packages/discord-bot/bot.ts:120

`Private` wireDiscordEventHandling

wireDiscordEventHandling(): Promise<void>
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:124

verifyMessage

verifyMessage(messageId: string, listenerId: null | SUUID): Promise<void>
Parameters
- messageId: string
- listenerId: null | SUUID
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:139

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in packages/discord-bot/bot.ts:159

destroy

destroy(): void
Returns void
Overrides Client.destroy
- Defined in packages/discord-bot/bot.ts:164

getDatabaseClient

getDatabaseClient(): Promise<Client>
Returns Promise<Client>
- Defined in packages/discord-bot/bot.ts:177

fetchApplication

fetchApplication(): Promise<ClientApplication>
Returns Promise<ClientApplication>
Inherited from Client.fetchApplication
- Defined in node_modules/discord.js/typings/index.d.ts:214

fetchGuildPreview

fetchGuildPreview(guild: GuildResolvable): Promise<GuildPreview>
Parameters
- guild: GuildResolvable
Returns Promise<GuildPreview>
Inherited from Client.fetchGuildPreview
- Defined in node_modules/discord.js/typings/index.d.ts:215

fetchInvite

fetchInvite(invite: string): Promise<Invite>
Parameters
- invite: string
Returns Promise<Invite>
Inherited from Client.fetchInvite
- Defined in node_modules/discord.js/typings/index.d.ts:216

fetchGuildTemplate

fetchGuildTemplate(template: string): Promise<GuildTemplate>
Parameters
- template: string
Returns Promise<GuildTemplate>
Inherited from Client.fetchGuildTemplate
- Defined in node_modules/discord.js/typings/index.d.ts:217

fetchVoiceRegions

fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>
Returns Promise<Collection<string, VoiceRegion>>
Inherited from Client.fetchVoiceRegions
- Defined in node_modules/discord.js/typings/index.d.ts:218

fetchWebhook

fetchWebhook(id: string, token?: string): Promise<Webhook>
Parameters
- id: string
- Optional token: string
Returns Promise<Webhook>
Inherited from Client.fetchWebhook
- Defined in node_modules/discord.js/typings/index.d.ts:219

generateInvite

generateInvite(options?: InviteGenerationOptions | PermissionResolvable): Promise<string>
Parameters
- Optional options: InviteGenerationOptions | PermissionResolvable
Returns Promise<string>
Inherited from Client.generateInvite
- Defined in node_modules/discord.js/typings/index.d.ts:220

login

login(token?: string): Promise<string>
Parameters
- Optional token: string
Returns Promise<string>
Inherited from Client.login
- Defined in node_modules/discord.js/typings/index.d.ts:221

sweepMessages

sweepMessages(lifetime?: number): number
Parameters
- Optional lifetime: number
Returns number
Inherited from Client.sweepMessages
- Defined in node_modules/discord.js/typings/index.d.ts:222

toJSON

toJSON(): object
Returns object
Inherited from Client.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:223

on

on<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): default
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns default
Inherited from Client.on
- Defined in node_modules/discord.js/typings/index.d.ts:225
on<S>(event: Exclude<S, keyof ClientEvents>, listener: ((...args: any[]) => void)): default
Type Parameters
- S extends string | symbol
Parameters
- event: Exclude<S, keyof ClientEvents>
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.on
- Defined in node_modules/discord.js/typings/index.d.ts:226

once

once<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): default
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns default
Inherited from Client.once
- Defined in node_modules/discord.js/typings/index.d.ts:231
once<S>(event: Exclude<S, keyof ClientEvents>, listener: ((...args: any[]) => void)): default
Type Parameters
- S extends string | symbol
Parameters
- event: Exclude<S, keyof ClientEvents>
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.once
- Defined in node_modules/discord.js/typings/index.d.ts:232

emit

emit<K>(event: K, ...args: ClientEvents[K]): boolean
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- Rest ...args: ClientEvents[K]
Returns boolean
Inherited from Client.emit
- Defined in node_modules/discord.js/typings/index.d.ts:237
emit<S>(event: Exclude<S, keyof ClientEvents>, ...args: any[]): boolean
Type Parameters
- S extends string | symbol
Parameters
- event: Exclude<S, keyof ClientEvents>
- Rest ...args: any[]
Returns boolean
Inherited from Client.emit
- Defined in node_modules/discord.js/typings/index.d.ts:238

off

off<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): default
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns default
Inherited from Client.off
- Defined in node_modules/discord.js/typings/index.d.ts:240
off<S>(event: Exclude<S, keyof ClientEvents>, listener: ((...args: any[]) => void)): default
Type Parameters
- S extends string | symbol
Parameters
- event: Exclude<S, keyof ClientEvents>
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.off
- Defined in node_modules/discord.js/typings/index.d.ts:241

removeAllListeners

removeAllListeners<K>(event?: K): default
Type Parameters
- K extends keyof ClientEvents
Parameters
- Optional event: K
Returns default
Inherited from Client.removeAllListeners
- Defined in node_modules/discord.js/typings/index.d.ts:246
removeAllListeners<S>(event?: Exclude<S, keyof ClientEvents>): default
Type Parameters
- S extends string | symbol
Parameters
- Optional event: Exclude<S, keyof ClientEvents>
Returns default
Inherited from Client.removeAllListeners
- Defined in node_modules/discord.js/typings/index.d.ts:247

clearInterval

clearInterval(interval: Timeout): void
Parameters
- interval: Timeout
Returns void
Inherited from Client.clearInterval
- Defined in node_modules/discord.js/typings/index.d.ts:131

clearTimeout

clearTimeout(timeout: Timeout): void
Parameters
- timeout: Timeout
Returns void
Inherited from Client.clearTimeout
- Defined in node_modules/discord.js/typings/index.d.ts:132

clearImmediate

clearImmediate(timeout: Immediate): void
Parameters
- timeout: Immediate
Returns void
Inherited from Client.clearImmediate
- Defined in node_modules/discord.js/typings/index.d.ts:133

setInterval

setInterval(fn: ((...args: any[]) => void), delay: number, ...args: any[]): Timeout
Parameters
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- delay: number
- Rest ...args: any[]
Returns Timeout
Inherited from Client.setInterval
- Defined in node_modules/discord.js/typings/index.d.ts:135

setTimeout

setTimeout(fn: ((...args: any[]) => void), delay: number, ...args: any[]): Timeout
Parameters
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- delay: number
- Rest ...args: any[]
Returns Timeout
Inherited from Client.setTimeout
- Defined in node_modules/discord.js/typings/index.d.ts:136

setImmediate

setImmediate(fn: ((...args: any[]) => void), ...args: any[]): Immediate
Parameters
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Rest ...args: any[]
Returns Immediate
Inherited from Client.setImmediate
- Defined in node_modules/discord.js/typings/index.d.ts:137

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): default
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.addListener
- Defined in node_modules/@types/node/events.d.ts:62

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): default
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.removeListener
- Defined in node_modules/@types/node/events.d.ts:65

setMaxListeners

setMaxListeners(n: number): default
Parameters
- n: number
Returns default
Inherited from Client.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Client.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Client.listeners
- Defined in node_modules/@types/node/events.d.ts:70

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Client.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71

listenerCount

listenerCount(event: string | symbol): number
Parameters
- event: string | symbol
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): default
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.prependListener
- Defined in node_modules/@types/node/events.d.ts:75

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): default
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns default
Inherited from Client.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from Client.eventNames
- Defined in node_modules/@types/node/events.d.ts:77

`Static` once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Client.once
- Defined in node_modules/@types/node/events.d.ts:26
once(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from Client.once
- Defined in node_modules/@types/node/events.d.ts:27

`Static` on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from Client.on
- Defined in node_modules/@types/node/events.d.ts:28

`Static` listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number
Deprecated
since v4.0.0
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from Client.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ClientOptions

Returns default

Properties

config

type

discordBotsDbGateway

dmChannelsDbGateway

guildCommands

dmCommands

isConfigured

status

botInstanceId

messageProcessingVerifier

channels

Readonly emojis

guilds

readyAt

Readonly readyTimestamp

shard

token

Readonly uptime

user

users

voice

ws

options

Static Readonly errorMonitor

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Methods

start

Returns Promise<void>

updateStatus

Parameters

status: DiscordBotStatus

Returns Promise<void>

Private attemptToBecomeListener

Parameters

Optional listenerId: null | SUUID

Returns Promise<boolean>

Private listenForDatabaseNotifications

Returns Promise<void>

notifyMessageProcessed

Parameters

message: Message

Returns Promise<void>

handleBotStatusUpdate

Parameters

_payload: any

Returns Promise<void>

handleBotMessageProcessing

Parameters

payload: any

Returns void

Private wireDiscordEventHandling

Returns Promise<void>

verifyMessage

Parameters

messageId: string

listenerId: null | SUUID

Returns Promise<void>

disconnect

Returns Promise<void>

destroy

Returns void

getDatabaseClient

Returns Promise<Client>

fetchApplication

Returns Promise<ClientApplication>

fetchGuildPreview

`Optional` options: ClientOptions

`Readonly` emojis

`Readonly` readyTimestamp

`Readonly` uptime

`Static` `Readonly` errorMonitor

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Private` attemptToBecomeListener

`Optional` listenerId: null | SUUID

`Private` listenForDatabaseNotifications

`Private` wireDiscordEventHandling

`Optional` token: string

`Optional` options: InviteGenerationOptions | PermissionResolvable

`Optional` token: string

`Optional` lifetime: number

`Rest` ...args: ClientEvents[K]

`Rest` ...args: any[]

`Rest` ...args: ClientEvents[K]

`Rest` ...args: any[]