Class Bot<TUser>Abstract

constructor

• new Bot<TUser>(clientID, secret, client): Bot<TUser>

• Create a bot.

  Type Parameters

  • TUser = GuildMember

  Parameters

  • clientID: string

    Client ID (unused right now)
  • secret: string

    Bot secret
  • client: Client<boolean>

    Base Discord client with intentions set

  Returns Bot<TUser>

client

commands

components

errorPing

hasStarted

Readonly log

logChannel

getChannel

• getChannel<T>(id): T

• Gets a channel by id.

  Type Parameters

  • T extends GuildBasedChannel = TextChannel

  Parameters

  • id: string

    Channel id

  Returns T

  Channel

getRole

• getRole(id): Role

• Gets a role by an id.

  Parameters

  • id: string

    Role id

  Returns Role

  Role

getUserV2

• getUserV2(id, guild?): 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): Promise<void>

• Runs when the bot joins a guild.

  Parameters

  • guild: Guild

    Guild

  Returns Promise<void>

onInteraction

• onInteraction(message): Promise<void>

• Runs when there is an interaction.

  Parameters

  • message: Interaction

    Interaction

  Returns Promise<void>

onLogin

• onLogin(c): Promise<void>

• Runs after the bot logs in.

  Parameters

  • c: Client<boolean>

    Client

  Returns Promise<void>

onMemberLeave

• onMemberLeave(user): Promise<void>

• Runs when a user leaves.

  Parameters

  • user: GuildMember | PartialGuildMember

    User

  Returns Promise<void>

onMessage

• onMessage(msg): Promise<void>

• Runs when a message is sent.

  Parameters

  • msg: Message<boolean>

    Message

  Returns Promise<void>

onNewMember

• onNewMember(user): Promise<void>

• Runs when a user joins.

  Parameters

  • user: GuildMember

    User

  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): void

• Register a command.

  Parameters

  • command: Command<Bot<TUser>, TUser, Bot<TUser>>

    Command to register

  Returns void

run

• run(): Promise<void>

• Start the bot.

  Returns Promise<void>

userExists

• userExists(id): 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.