Skip to content
GitHub

MessageHelpEntry

interface in meocord/interface Since 4.1.0

interface MessageHelpEntry

One message command as the built-in help shows it: how to type it, what it does, and where it works.

Members

usage

usage: string

The command as the caller types it here, such as !mute <target> [duration] [reason…].

command

command: string

The words that name the command, such as mute, or '' for a pattern that begins with a param.

description

description?: string

What 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: MessageScope

Where 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.

See also