Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HelpOptions

Hierarchy

  • HelpOptions

Index

Properties

Methods

Properties

Optional color

color?: ColorResolvable

Colour of the embed

commands

commands: Commands

Commands to give help for. Only supports discord-express command object

Optional components

components?: (MessageActionRow | (Required<BaseMessageComponentOptions> & MessageActionRowOptions))[]

Message components to add to the help message

Optional description

description?: string

Description of the embed for the top level help message

Optional fallbackToDMs

fallbackToDMs?: boolean

Where the help message should be sent if not ephemeral

Optional footerText

footerText?: string

Footer text of the embed

Optional matcher

matcher?: <T>(obj: {}, key: string) => [trueKey: string, value?: T]

Type declaration

    • <T>(obj: {}, key: string): [trueKey: string, value?: T]

    • Custom command matcher. The default matcher accounts for direct matches, camelCase matches, and uncapitalized matches.

      Type parameters

      • T

      Parameters

      • obj: {}
        • [key: string]: T
      • key: string

      Returns [trueKey: string, value?: T]

Optional thumbnail

thumbnail?: Partial<MessageEmbedThumbnail> & {}

Thumbnail URL of the embed

Optional title

title?: string

Title of the help message

Optional url

url?: string

URL of the embed

Methods

Optional generateCommandHelp

  • generateCommandHelp(commandArray: [string, string?, string?], command: Command, request: Request, defaultData: MessageEmbedOptions): MessageEmbed

  • Custom embed generator to show help for a specific command

    Parameters

    • commandArray: [string, string?, string?]
    • command: Command
    • request: Request
    • defaultData: MessageEmbedOptions

    Returns MessageEmbed

Optional generateSubcommandGroupHelp

  • generateSubcommandGroupHelp(commandArray: [string], subcommandGroup: SubcommandGroup, request: Request, defaultData: MessageEmbedOptions): MessageEmbed

Optional generateSubcommandHelp

  • generateSubcommandHelp(commandArray: [string, string?], subcommand: Subcommand, request: Request, defaultData: MessageEmbedOptions): MessageEmbed

  • Custom embed generator to show help for a specific subcommand

    Parameters

    • commandArray: [string, string?]
    • subcommand: Subcommand
    • request: Request
    • defaultData: MessageEmbedOptions

    Returns MessageEmbed

Optional generateTopLevelHelp

  • generateTopLevelHelp(commands: Commands, request: Request, defaultData: MessageEmbedOptions): MessageEmbed

Generated using TypeDoc