Class Artibot

Powerful Discord bot system.

Author

Artivain info@artivain.com

Author

Thomas Fournier thomas@artivain.com

See

License

GPL-3.0-or-later

Hierarchy

  • Artibot

Constructors

constructor

Properties

#token client? config contributors cooldowns interactionManager? localizer log modules registerModule version

Methods

checkForPackageUpdates checkForUpdates createEmbed login

Constructors

constructor

Properties

Private #token

#token: string = ""

The token to login into Discord

Optional client

client?: Client<boolean>

Discord.js client

config

config: ArtibotConfig

Stores the Artibot config object

Readonly contributors

contributors: ContributorList = ...

Lists of people who contributed to the Artibot

cooldowns

cooldowns: Collection<string, Collection<string, number>> = ...

Store cooldowns for the commands

Optional interactionManager

interactionManager?: InteractionManager

Instance of InteractionManager

localizer

localizer: Localizer = ...

Localizer using the default strings for Artibot

log

log: ((name: string, msg: string, type?: "debug" | "warn" | "log" | "err" | "info", isCore?: boolean) => void) = log

Type declaration

    • (name: string, msg: string, type?: "debug" | "warn" | "log" | "err" | "info", isCore?: boolean): void

    • Deprecated

      Please directly use the exported log directly

      Parameters

      • name: string
      • msg: string
      • type: "debug" | "warn" | "log" | "err" | "info" = "log"
      • isCore: boolean = false

      Returns void

modules

modules: Collection<string, Module> = ...

Registered modules

Readonly registerModule

registerModule: RegisterModuleOverload = ...

Register a module in Artibot

Param

The module to register or a function to initialize the module

Param

Custom configuration for the module. See module documentation to learn more.

version

version: string = version

Version of Artibot

Methods

Readonly checkForPackageUpdates

  • Get latest release version of a NPM package

    Returns

    Version number, or false if package not found or an error happens

    Method

    Async

    Parameters

    • packageName: string = "artibot"

      Package name on NPM

    Returns Promise<string | false>

Readonly checkForUpdates

  • Get latest release version of a GitHub repository

    Returns

    Version number, or false if repo not found or an error happens

    Parameters

    • repo: string = "Artivain/artibot"

      GitHub repository to get latest version

    Returns Promise<string | false>

createEmbed

  • Create an embed

    Returns

    A new embed builder, already configured with the defaults from the config

    Parameters

    • Optional data: EmbedData

      Data to set in the embed

    Returns EmbedBuilder

Readonly login

  • Method

    Async

    Parameters

    • config: {
          additionalIntents?: IntentsBitField[];
          token: string;
      }

      Advanced config for the bot

      • Optional additionalIntents?: IntentsBitField[]

        Additional intents to register in the Discord client

      • token: string

        The login token for the Discord bot

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.28