Class Commander

Hierarchy

Commander

Index

Constructors

constructor

new Commander(config?: Partial<CommanderOptions>): Commander

- Defined in src/Commander.ts:40
Parameters
- Default value config: Partial<CommanderOptions> = {}
Returns Commander

Properties

Private commands

commands: BaseCommand[] = []

config

config: CommanderOptions

Private instances

instances: TeamSpeak[] = []

Static DEFAULT_PREFIX

DEFAULT_PREFIX: string = "!"

Methods

addInstance

addInstance(teamspeak: TeamSpeak, registerEvents?: boolean): Promise<this>

- Defined in src/Commander.ts:235
adds a teamspeak instance to the command handler

Parameters
- teamspeak: TeamSpeak
  
  the instance to add
- Default value registerEvents: boolean = true
  
  depending on this setting the registerEvent command will be sent to the teamspeak server
Returns Promise<this>

checkPermissions

checkPermissions(commands: BaseCommand[], client: TeamSpeakClient): Promise<BaseCommand[]>

- Defined in src/Commander.ts:155
Parameters
- commands: BaseCommand[]
- client: TeamSpeakClient
Returns Promise<BaseCommand[]>

createCommand

createCommand(name: string): Command

- Defined in src/Commander.ts:212
creates a new command

Parameters
- name: string
  
  the name of the command
Returns Command

createCommandGroup

createCommandGroup(name: string): CommandGroup

- Defined in src/Commander.ts:223
creates a new command

Parameters
- name: string
  
  the name of the command
Returns CommandGroup

getAvailableCommands

getAvailableCommands(name?: undefined | string): BaseCommand[]

- Defined in src/Commander.ts:166
gets a list of enabled commands

Parameters
- Optional name: undefined | string
  
  the name to find
Returns BaseCommand[]

getAvailableCommandsWithPermission

getAvailableCommandsWithPermission(client: TeamSpeakClient, filter?: undefined | string): Promise<BaseCommand[]>

- Defined in src/Commander.ts:194
gets a list of availale commands with permission checks

Parameters
- client: TeamSpeakClient
  
  the client to check permissions for
- Optional filter: undefined | string
  
  the name to prefilter commands
Returns Promise<BaseCommand[]>

getReplyFunction

getReplyFunction(ev: TextMessageEvent): (Anonymous function)

- Defined in src/Commander.ts:142
Parameters
- ev: TextMessageEvent
Returns (Anonymous function)

Private getTranslatedString

getTranslatedString(__namedParameters: object): string

- Defined in src/Commander.ts:78
retrieves a string from a CommanderString Type

Parameters
- __namedParameters: object
  - client: TeamSpeakClient
  - data: string | function
    
    the string getter data
  - rest: rest
Returns string

Private getTranslator

getTranslator(event: TextMessageEvent): TranslationStringGetter

- Defined in src/Commander.ts:68
Parameters
- event: TextMessageEvent
Returns TranslationStringGetter

isPossibleCommand

isPossibleCommand(text: string): boolean

- Defined in src/Commander.ts:203
Parameters
- text: string
Returns boolean

prefix

prefix(): string

- Defined in src/Commander.ts:199
Returns string

Private runCommand

runCommand(cmd: BaseCommand, args: string, event: CommanderTextMessage, translate: TranslationStringGetter): Promise<void>

- Defined in src/Commander.ts:117
Parameters
- cmd: BaseCommand
- args: string
- event: CommanderTextMessage
- translate: TranslationStringGetter
Returns Promise<void>

searchAvailableCommands

searchAvailableCommands(name: string, client: TeamSpeakClient): BaseCommand[]

- Defined in src/Commander.ts:177
regex searches available commands

Parameters
- name: string
  
  the name to find
- client: TeamSpeakClient
  
  the requesting client
Returns BaseCommand[]

Private textMessageHandler

textMessageHandler(event: CommanderTextMessage): Promise<any>

- Defined in src/Commander.ts:101
Parameters
- event: CommanderTextMessage
Returns Promise<any>

translateString

translateString(client: TeamSpeakClient): (Anonymous function)

- Defined in src/Commander.ts:95
gets a string translation with the client object

Parameters
- client: TeamSpeakClient
Returns (Anonymous function)

Static createThrottle

createThrottle(): Throttle

- Defined in src/Commander.ts:64
creates a new Throttle instance

Returns Throttle

Static isValidCommandName

isValidCommandName(name: string): boolean

- Defined in src/Commander.ts:259
checks if the command name is valid to be created as a command

Parameters
- name: string
  
  the command to create
Returns boolean

Generated using TypeDoc