Skip to content

Constructors ​

Constructor ​

new CommandManager(options): CommandManager

Parameters ​

options ​
getAdmins ​

() => readonly string[]

getDefaultPrefix ​

() => string

getOwners ​

() => readonly string[]

logger? ​

{ error: void; }

logger.error ​

Returns ​

CommandManager

Methods ​

catalog() ​

catalog(): CommandCatalogItem[]

Returns ​

CommandCatalogItem[]


clear() ​

clear(): void

Returns ​

void


dispatch() ​

dispatch(event): Promise<boolean>

Parameters ​

event ​

MessageEvent

Returns ​

Promise<boolean>


getPluginHelp() ​

getPluginHelp(plugin): PluginHelp | undefined

Parameters ​

plugin ​

string

Returns ​

PluginHelp | undefined


list() ​

list(): readonly RegisteredCommand[]

Returns ​

readonly RegisteredCommand[]


register() ​

Call Signature ​

register(plugin, definition, context): () => void

Parameters ​
plugin ​

string

definition ​

CommandDefinition

context ​

MiokuContext

Returns ​

() => void

Call Signature ​

register(plugin, matcher, handler, options?, context?): () => void

Parameters ​
plugin ​

string

matcher ​

CommandMatcher

handler ​

CommandHandler

options? ​

CommandShortcutOptions

context? ​

MiokuContext

Returns ​

() => void


removePlugin() ​

removePlugin(plugin): void

Parameters ​

plugin ​

string

Returns ​

void


setAccessControl() ​

setAccessControl(config): void

Parameters ​

config ​

AccessControlConfig | undefined

Returns ​

void


shouldDispatch() ​

shouldDispatch(source, event): boolean

Parameters ​

source ​

string

event ​

Event

Returns ​

boolean


syncMetadata() ​

syncMetadata(metadata): void

Parameters ​

metadata ​

PluginMetadata

Returns ​

void

Released under the MIT License with love.