Class BaseCommand

Hierarchy

BaseCommand
- Command
- CommandGroup

Index

Constructors

constructor

Properties

Constructors

constructor

new BaseCommand(cmd: string, commander: Commander): BaseCommand

- Defined in src/command/BaseCommand.ts:19
Parameters
- cmd: string
- commander: Commander
Returns BaseCommand

Properties

Private cmdEnabled

cmdEnabled: boolean = true

Private cmdHelp

cmdHelp: TranslationString = ""

Private cmdManual

cmdManual: TranslationString[] = []

Private cmdName

cmdName: TranslationString

Private cmdPrefix

cmdPrefix: string = ""

Private cmdThrottle

cmdThrottle: Throttle

Protected commander

commander: Commander

Protected permissionHandler

permissionHandler: permissionHandler[] = []

Protected runHandler

runHandler: runHandler[] = []

Methods

addThrottle

addThrottle(throttle: Throttle): this

- Defined in src/command/BaseCommand.ts:137
adds an instance of a throttle class

Parameters
- throttle: Throttle
  
  adds the throttle instance
Returns this

checkPermission

checkPermission(callback: permissionHandler): this

- Defined in src/command/BaseCommand.ts:156
register a permission handler for this command

Parameters
- callback: permissionHandler
  
  gets called whenever the permission for a client gets checked
Returns this

clearManual

clearManual(): this

- Defined in src/command/BaseCommand.ts:119
clears the current manual text

Returns this

disable

disable(): this

- Defined in src/command/BaseCommand.ts:43
Returns this

Protected dispatchCommand

dispatchCommand(ev: CommanderTextMessage): Promise<void>

- Defined in src/command/BaseCommand.ts:165
Parameters
- ev: CommanderTextMessage
Returns Promise<void>

enable

enable(): this

- Defined in src/command/BaseCommand.ts:37
Returns this

getCommandName

getCommandName(): string | function

- Defined in src/command/BaseCommand.ts:49
gets the command name without its prefix

Returns string | function

getFullCommandName

getFullCommandName(): string

- Defined in src/command/BaseCommand.ts:54
gets the command name with its prefix

Returns string

getHelp

getHelp(client: TeamSpeakClient): string

- Defined in src/command/BaseCommand.ts:59
retrieves the help text

Parameters
- client: TeamSpeakClient
Returns string

getManual

getManual(client: TeamSpeakClient): string

- Defined in src/command/BaseCommand.ts:78
retrieves the current manual text

Parameters
- client: TeamSpeakClient
Returns string

getPrefix

getPrefix(): string

- Defined in src/command/BaseCommand.ts:101
gets the current prefix for this command

Returns string

Abstract getUsage

getUsage(): string

- Defined in src/command/BaseCommand.ts:26
Returns string

Abstract handleRequest

handleRequest(args: string, ev: CommanderTextMessage): Promise<void>

- Defined in src/command/BaseCommand.ts:29
Parameters
- args: string
- ev: CommanderTextMessage
Returns Promise<void>

Private handleThrottle

handleThrottle(client: TeamSpeakClient): void

- Defined in src/command/BaseCommand.ts:142
Parameters
- client: TeamSpeakClient
Returns void

hasHelp

hasHelp(): boolean

- Defined in src/command/BaseCommand.ts:73
returns a boolean wether a help text has been set or not

Returns boolean

hasManual

hasManual(): boolean

- Defined in src/command/BaseCommand.ts:85
returns a boolean wether a help text has been set or not

Returns boolean

Abstract hasPermission

hasPermission(client: TeamSpeakClient): Promise<boolean>

- Defined in src/command/BaseCommand.ts:27
Parameters
- client: TeamSpeakClient
Returns Promise<boolean>

help

help(text: TranslationString): this

- Defined in src/command/BaseCommand.ts:67
sets a help text (should be a very brief description)

Parameters
- text: TranslationString
  
  help text
Returns this

isEnabled

isEnabled(): boolean

- Defined in src/command/BaseCommand.ts:32
checks if the command is enabled

Returns boolean

manual

manual(text: TranslationString): this

- Defined in src/command/BaseCommand.ts:111
sets a manual text, this function can be called multiple times in order to create a multilined manual text

Parameters
- text: TranslationString
  
  the manual text
Returns this

Protected permCheck

permCheck(client: TeamSpeakClient): Promise<boolean>

- Defined in src/command/BaseCommand.ts:161
Parameters
- client: TeamSpeakClient
Returns Promise<boolean>

prefix

prefix(prefix: string): this

- Defined in src/command/BaseCommand.ts:95
sets a prefix for this command should only used in specific cases by default the prefix gets inherited from its Commander

Parameters
- prefix: string
  
  the new prefix for this command
Returns this

run

run(callback: runHandler): this

- Defined in src/command/BaseCommand.ts:128
register an execution handler for this command

Parameters
- callback: runHandler
  
  gets called whenever the command should do something
Returns this

Abstract validate

validate(args: string): Record<string, any>

- Defined in src/command/BaseCommand.ts:28
Parameters
- args: string
Returns Record<string, any>

Generated using TypeDoc