Help

Vocality Documentation › Globals › Help

Hierarchy

• Help

Implements

• Command

Index

Methods

• buildMultiCommandEmbed
• buildSingleCommandEmbed
• execute

Object literals

• options

Methods

Private buildMultiCommandEmbed

▸ buildMultiCommandEmbed(guildId: string, results: CommandSearchResult[]): MessageEmbed

Defined in packages/vocality-core/src/commands/Help.ts:54

Parameters:

Name	Type
guildId	string
results	CommandSearchResult[]

Returns: MessageEmbed

---

Private buildSingleCommandEmbed

▸ buildSingleCommandEmbed(guildId: string, result: CommandSearchResult): MessageEmbed

Defined in packages/vocality-core/src/commands/Help.ts:85

Parameters:

Name	Type
guildId	string
result	CommandSearchResult

Returns: MessageEmbed

---

execute

▸ execute(msg: Message, args: string[]): void

Defined in packages/vocality-core/src/commands/Help.ts:21

Parameters:

Name	Type
msg	Message
args	string[]

Returns: void

Object literals

options

▪ options: object

Defined in packages/vocality-core/src/commands/Help.ts:12

description

• description: string = "Shows command information"

Defined in packages/vocality-core/src/commands/Help.ts:18

usage

• usage: string = "help (command)"

Defined in packages/vocality-core/src/commands/Help.ts:17

▪ id: object

Defined in packages/vocality-core/src/commands/Help.ts:13

• aliases: string[] = ['h']

• name: string = "help"