MessageHelpEntry
interface in meocord/interface Since 4.1.0
interface MessageHelpEntryOne message command as the built-in help shows it: how to type it, what it does, and where it works.
Members
usage
usage: stringThe command as the caller types it here, such as !mute <target> [duration] [reason…].
command
command: stringThe words that name the command, such as mute, or '' for a pattern that begins with a param.
description
description?: stringWhat the command does, from its handler's description.
aliases
aliases: string[]Its aliases and other spellings, as the caller types them, such as !m.
scope
scope: MessageScopeWhere it works; a command with a member, role or channel param works in servers only.
params
params: MessageHelpParam[]Each param and flag, with what it takes.
handler
handler: { controller: string; method: string }The class and method that handle it, by name.