import Bot from 'discord-graf/src/bot/index.js'

public class | source

Bot

A Discord bot that has its own command registry, storage, utilities, etc.

Constructor Summary

Public Constructor
public	constructor(config: ConfigObject)

Member Summary

Public Members
public	client: Client
public	config: BotConfig
public	dispatcher: CommandDispatcher
public	evalObjects: Object
public	localStorage: LocalStorage
public get	logger: Logger
public	permissions: BotPermissions
public get	registry: CommandRegistry
public	storage: Object
public	util: BotUtil

Method Summary

Public Methods
public	buildCommand(info: CommandInfo, funcs: CommandBuilderFunctions): CommandBuilder Create a command builder
public	createClient(): Client Instantiates all bot classes and storages, and creates the client
public	registerCommand(command: Command \| function): Bot Registers a single command to the bot's registry
public	registerCommands(commands: Command[] \| function[]): Bot Registers multiple commands to the bot's registry
public	registerDefaultCommands(options: Object): Bot Registers the default commands to the bot's registry
public	registerDefaultModules(): Bot Registers the default modules to the bot's registry
public	registerDefaults(): Bot Registers both the default modules and commands to the bot's registry
public	registerEvalObject(key: string, obj: Object): Bot Registers a single object to be usable by the eval command
public	registerEvalObjects(obj: Object): Bot Registers multiple objects to be usable by the eval command
public	registerModule(module: Module \| function \| string[]): Bot Registers a single module to the bot's registry
public	registerModules(modules: Module[] \| function[] \| Array[]): Bot Registers multiple modules to the bot's registry

Public Constructors

public constructor(config: ConfigObject) source

Params:

Name	Type	Attribute	Description
config	ConfigObject		The configuration to use

Public Members

public client: Client source

public config: BotConfig source

public dispatcher: CommandDispatcher source

public evalObjects: Object source

public localStorage: LocalStorage source

public get logger: Logger source

public permissions: BotPermissions source

public get registry: CommandRegistry source

public storage: Object source

Properties:

Name	Type	Attribute	Description
settings	SettingStorage
modRoles	ModRoleStorage
allowedChannels	AllowedChannelStorage

public util: BotUtil source

Public Methods

public buildCommand(info: CommandInfo, funcs: CommandBuilderFunctions): CommandBuilder source

Create a command builder

Params:

Name	Type	Attribute	Description
info	CommandInfo	optional	The command information
funcs	CommandBuilderFunctions	optional	The command functions to set

Return:

CommandBuilder

The builder

public createClient(): Client source

Instantiates all bot classes and storages, and creates the client

Return:

Client

The bot client

public registerCommand(command: Command | function): Bot source

Registers a single command to the bot's registry

Params:

Name	Type	Attribute	Description
command	Command \| function		Either a Command instance, or a constructor for one

Return:

Bot

This bot

See:

Bot#registerCommands

public registerCommands(commands: Command[] | function[]): Bot source

Registers multiple commands to the bot's registry

Params:

Name	Type	Attribute	Description
commands	Command[] \| function[]		An array of Command instances or constructors

Return:

Bot

This bot

public registerDefaultCommands(options: Object): Bot source

Registers the default commands to the bot's registry

Params:

Name	Type	Attribute	Description
options	Object	optional	Object specifying what commands to register
options.about	boolean	optional default: true	Whether or not to register the built-in about command
options.modRoles	boolean	optional default: true	Whether or not to register the built-in mod roles commands
options.channels	boolean	optional default: true	Whether or not to register the built-in channels commands
options.blacklist	boolean	optional default: true	Whether or not to register the built-in blacklist commands