Interface ICommandArguments

Hierarchy

  • ICommandArguments

Properties

Properties

Designates how the arguments for the command will be accepted

Param

Command arguments are passed in as an object with key-value pairs

Example

User: /command --param1=value --param2=value

Param

Command arguments are passed in as space-separated values

Example

User: /command value1 value2

Param

Command arguments are received through standard input

Example

User: /command
Bot: What value do you want to specify?
User: value

Param

Accepted for only one argument, returns all text from the message

Example

User: /command here is a lot of text that will carry over completely into one argument
value: string[] | [string, {
    question?: string;
    regexp?: RegExp;
}][]

Generated using TypeDoc