Class RegisteredChatCommand

Hierarchy

RegisteredChatCommand

Index

Methods

parse parseCommandUsageString checkArguments

Properties

accessCheck callback description usage

Constructors

Methods

`Static` parse

parse(usageString: string, description: string, accessCheck: AccessCheckFn, callback: ChatCommandCallback): RegisteredChatCommand
Parameters
- usageString: string
- description: string
- accessCheck: AccessCheckFn
- callback: ChatCommandCallback
Returns RegisteredChatCommand
- Defined in src/handlers/ChatCommandHandler.ts:139

`Static` parseCommandUsageString

parseCommandUsageString(usage: string): ChatCommandUsage
Parameters
- usage: string
Returns ChatCommandUsage
- Defined in src/handlers/ChatCommandHandler.ts:94

checkArguments

checkArguments(prefix: string, args: string[]): CommandCallError | Record<string, string>
Verify that an array of arguments correctly fits the usage of this command.

Returns
The arguments mapped from parameter name to value of the argument passed.
Parameters
- prefix: string
- args: string[]
  
  The arguments to verify.
Returns CommandCallError | Record<string, string>
- Defined in src/handlers/ChatCommandHandler.ts:151

Properties

`Readonly` accessCheck

accessCheck: AccessCheckFn

`Readonly` callback

callback: ChatCommandCallback

`Readonly` description

description: string

`Readonly` usage

usage: ChatCommandUsage

Constructors

constructor

new RegisteredChatCommand(usage: ChatCommandUsage, description: string, accessCheck: AccessCheckFn, callback: ChatCommandCallback): RegisteredChatCommand
Parameters
- usage: ChatCommandUsage
- description: string
- accessCheck: AccessCheckFn
- callback: ChatCommandCallback
Returns RegisteredChatCommand
- Defined in src/handlers/ChatCommandHandler.ts:87

Generated using TypeDoc