Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bot

Application instance

Hierarchy

  • EventEmitter
    • Bot

Index

Constructors

Events

Properties

Methods

Constructors

constructor

Events

on

  • on(event: "READY", listener: Function): Bot
  • on(event: "MESSAGE", listener: (m: Message) => void): Bot
  • on(event: "COMMAND", listener: (m: Message | CommandInteraction, cmdMsg: InputManager) => void): Bot
  • on(event: "ERROR", listener: (e: any) => void): Bot

  • Emitted after connecting to Discord API

    Parameters

    • event: "READY"
    • listener: Function

    Returns Bot

  • Emitted whenever bot receives a Discord message

    Parameters

    • event: "MESSAGE"
    • listener: (m: Message) => void
        • (m: Message): void

        • Parameters

          • m: Message

          Returns void

    Returns Bot

  • Emitted whenever bots receives a Discord message or interaction that gets recognized as a CommandBot command

    Parameters

    • event: "COMMAND"
    • listener: (m: Message | CommandInteraction, cmdMsg: InputManager) => void
        • (m: Message | CommandInteraction, cmdMsg: InputManager): void

        • Parameters

          Returns void

    Returns Bot

  • Emitted on every bot error

    Parameters

    • event: "ERROR"
    • listener: (e: any) => void
        • (e: any): void

        • Parameters

          • e: any

          Returns void

    Returns Bot

Properties

Readonly applicationId

applicationId: string

Discord API application ID

readonly

Readonly client

client: Client<boolean>

Discord.js {@link Client} instance

readonly

Readonly commands

commands: CommandManager

Instance command manager

readonly

Readonly messages

messages: SystemMessageManager

SystemMessageManager storing messages' configuration

readonly

Readonly name

name: string

Bot name

readonly

Readonly token

token: string

Discord Bot token

readonly

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

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.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Bot

  • Parameters

    • Optional event: string | symbol

    Returns Bot

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Bot

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Bot

setMaxListeners

  • setMaxListeners(n: number): Bot

  • Parameters

    • n: number

    Returns Bot

start

  • start(port?: number, register?: boolean): Promise<boolean>

  • Starts your Discord bot

    async

    Parameters

    • Optional port: number
    • Optional register: boolean

    Returns Promise<boolean>

    whether this operation has been completed successfully

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc