HelpCommandHelper

HelpCommandHelper

Assists in creating a help command. The HelpCommandHelper can be accessed via CommandManager#getHelpCommandHelper. For an example of how to use the HelpCommandHelper, see the monochrome demo help command You can use the demo help command in your bot. Just fill out the configuration section at the top.

Methods

findCommand(searchTerm) → {Command|undefined}

Description:
  • Do a fuzzy search for a command that matches the provided search term. Returns undefined if no match is found.
Source:
Parameters:
Name Type Description
searchTerm string The string to find a matching command for.
Returns:
Type
Command | undefined

(async) getEnabledNonHiddenCommands(msg) → {Array.<Command>}

Description:
  • Get all non-hidden commands that are enabled where the msg was sent.
Source:
Parameters:
Name Type Description
msg external:"Eris.Message" The Eris message that caused the help command to be invoked.
Returns:
Type
Array.<Command>

getNonHiddenCommands() → {Array.<Command>}

Description:
  • Get all commands that do not have their hidden property set to true.
Source:
Returns:
Type
Array.<Command>