Class Command

Hierarchy

Command

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new Command(label: string, generate: CommandGenerator, options?: CommandOptions): Command

- Defined in node_modules/eris/index.d.ts:1838
Parameters
- label: string
- generate: CommandGenerator
- Optional options: CommandOptions
Returns Command

Properties

aliases

aliases: string[]

argsRequired

argsRequired: boolean

caseInsensitive

caseInsensitive: boolean

cooldown

cooldown: number

cooldownExclusions

cooldownExclusions: CommandCooldownExclusions

cooldownMessage

cooldownMessage: string | false | AdvancedMessageContent | GenericCheckFunction<MessageContent>

cooldownReturns

cooldownReturns: number

defaultSubcommandOptions

defaultSubcommandOptions: CommandOptions

deleteCommand

deleteCommand: boolean

description

description: string

dmOnly

dmOnly: boolean

errorMessage

errorMessage: string | AdvancedMessageContent | GenericCheckFunction<MessageContent>

fullDescription

fullDescription: string

fullLabel

fullLabel: string

guildOnly

guildOnly: boolean

hidden

hidden: boolean

hooks

hooks: Hooks

invalidUsageMessage

invalidUsageMessage: string | false | AdvancedMessageContent | GenericCheckFunction<MessageContent>

label

label: string

Optional parentCommand

parentCommand: undefined | Command

permissionMessage

permissionMessage: string | false | AdvancedMessageContent | GenericCheckFunction<MessageContent>

reactionButtonTimeout

reactionButtonTimeout: number

reactionButtons

reactionButtons: null | CommandReactionButtons[]

requirements

requirements: CommandRequirements

restartCooldown

restartCooldown: boolean

subcommandAliases

subcommandAliases: {}

Type declaration

[alias: string]: string

subcommands

subcommands: {}

Type declaration

[s: string]: Command

usage

usage: string

Methods

cooldownCheck

cooldownCheck(msg: Message<TextableChannel>): boolean

- Defined in node_modules/eris/index.d.ts:1840
Parameters
- msg: Message<TextableChannel>
Returns boolean

cooldownExclusionCheck

cooldownExclusionCheck(msg: Message<TextableChannel>): boolean

- Defined in node_modules/eris/index.d.ts:1841
Parameters
- msg: Message<TextableChannel>
Returns boolean

executeCommand

executeCommand(msg: Message<TextableChannel>, args: string[]): Promise<GeneratorFunctionReturn>

- Defined in node_modules/eris/index.d.ts:1842
Parameters
- msg: Message<TextableChannel>
- args: string[]
Returns Promise<GeneratorFunctionReturn>

permissionCheck

permissionCheck(msg: Message<TextableChannel>): Promise<boolean>

- Defined in node_modules/eris/index.d.ts:1843
Parameters
- msg: Message<TextableChannel>
Returns Promise<boolean>

process

process(args: string[], msg: Message<TextableChannel>): Promise<GeneratorFunctionReturn>

- Defined in node_modules/eris/index.d.ts:1844
Parameters
- args: string[]
- msg: Message<TextableChannel>
Returns Promise<GeneratorFunctionReturn>

registerSubcommand

registerSubcommand(label: string, generator: CommandGenerator, options?: CommandOptions): Command

- Defined in node_modules/eris/index.d.ts:1845
Parameters
- label: string
- generator: CommandGenerator
- Optional options: CommandOptions
Returns Command

registerSubcommandAlias

registerSubcommandAlias(alias: string, label: string): void

- Defined in node_modules/eris/index.d.ts:1846
Parameters
- alias: string
- label: string
Returns void

toJSON

toJSON(props?: string[]): JSONCache

Implementation of SimpleJSON.toJSON
- Defined in node_modules/eris/index.d.ts:1849
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

- Defined in node_modules/eris/index.d.ts:1848
Returns string

unregisterSubcommand

unregisterSubcommand(label: string): void

- Defined in node_modules/eris/index.d.ts:1847
Parameters
- label: string
Returns void

Generated using TypeDoc