Class Bot<TUser>Abstract

constructor

• new Bot<TUser = GuildMember>(secret: string, client: Client): Bot<TUser>

  Create a bot.

  Type Parameters

  • TUser = GuildMember

    The default user object

  Parameters

  • secret: string

    Bot secret

  • client: Client

    Base Discord client with intentions set

  Returns Bot<TUser>

client

commands

components

errorPing

hasStarted

Readonlylog

logChannel

getChannel

• getChannel<T extends GuildBasedChannel = TextChannel>(id: string): T

  Gets a channel by id.

  Type Parameters

  • T extends GuildBasedChannel = TextChannel

  Parameters

  • id: string

    Channel id

  Returns T

  Channel

getRole

• getRole(id: string): Role

  Gets a role by an id.

  Parameters

  • id: string

    Role id

  Returns Role

  Role

getUserV2

• getUserV2(id: string, guild?: string): TUser
  Beta

  Gets a user by its id. This will eventually be renamed to getUser probably.

  Parameters

  • id: string

    User id

  • guild: string = ""

  Returns TUser

onClose

• onClose(): Promise<void>

  Runs right before the application quits.

  Returns Promise<void>

onGuildJoin

• onGuildJoin(guild: Guild): Promise<void>

  Runs when the bot joins a guild.

  Parameters

  • guild: Guild

    Guild

  Returns Promise<void>

onInteraction

• onInteraction(message: Interaction): Promise<void>

  Runs when there is an interaction.

  Parameters

  • message: Interaction

    Interaction

  Returns Promise<void>

onLogin

• onLogin(c: Client): Promise<void>

  Runs after the bot logs in.

  Parameters

  • c: Client

    Client

  Returns Promise<void>

onMemberLeave

• onMemberLeave(user: GuildMember | PartialGuildMember): Promise<void>

  Runs when a user leaves.

  Parameters

  • user: GuildMember | PartialGuildMember

    User

  Returns Promise<void>

onMessage

• onMessage(msg: Message): Promise<void>

  Runs when a message is sent.

  Parameters

  • msg: Message

    Message

  Returns Promise<void>

onNewMember

• onNewMember(user: GuildMember): Promise<void>

  Runs when a user joins.

  Parameters

  • user: GuildMember

    User

  Returns Promise<void>

onUserVoiceStateUpdate

• onUserVoiceStateUpdate(
      oldState: VoiceState,
      newState: VoiceState,
  ): Promise<void>

  Runs when a user's voice state changes. See discord.js documentation for more information.

  Parameters

  • oldState: VoiceState

    Old voice state

  • newState: VoiceState

    New voice state

  Returns Promise<void>

refreshCommands

• refreshCommands(): Promise<void>

  Refreshes commands for all servers.

  It is recommended to hook this up to a command.

  Returns Promise<void>

  Example

  export default class RefreshCommand<TUser, TBot<TUser>> extends Command<TUser, TBot<TUser>> {
       public getName() { return "refresh"; }
  
       public create() {
           return new SlashCommandBuilder()
               .setName(this.getName())
               .setDescription("Refresh commands")
               .setDefaultMemberPermissions(PermissionFlagsBits.ModerateMembers);
       }
  
       public async execute(msg: ChatInputCommandInteraction<CacheType>) {
           await msg.deferReply();
           await this.bot.refreshCommands();
           await msg.editReply("Refreshed commands");
       }
  }
  Copy

registerCommand

• registerCommand(...command: Command<Bot<TUser>, TUser, Bot<TUser>>[]): void

  Register commands.

  Parameters

  • ...command: Command<Bot<TUser>, TUser, Bot<TUser>>[]

    Commands to register

  Returns void

registerComponent

• registerComponent<T extends Component<Bot<TUser>, TUser, Bot<TUser>>>(
      component: T,
  ): T

  Register a component.

  Type Parameters

  • T extends Component<Bot<TUser>, TUser, Bot<TUser>>

  Parameters

  • component: T

  Returns T

run

• run(): Promise<void>

  Start the bot.

  Returns Promise<void>

userExists

• userExists(id: string): boolean

  Checks to see if a user is in any of the servers this bot is in.

  Parameters

  • id: string

    User id

  Returns boolean

  If the user is in a server

  Remarks

  It is recommended to only use this if this bot is only in one server.