Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Command

Hierarchy

Index

Constructors

constructor

Properties

Private arguments

arguments: Argument[] = []

Protected commander

commander: Commander

Protected permissionHandler

permissionHandler: permissionHandler[] = []

Protected runHandler

runHandler: runHandler[] = []

Methods

addArgument

addThrottle

checkPermission

clearManual

  • clearManual(): this

disable

  • disable(): this

Protected dispatchCommand

enable

  • enable(): this

getArguments

getCommandName

  • getCommandName(): string | function

getFullCommandName

  • getFullCommandName(): string

getHelp

  • getHelp(client: TeamSpeakClient): string

getManual

  • getManual(client: TeamSpeakClient): string

getPrefix

  • getPrefix(): string

getUsage

  • getUsage(): string

handleRequest

hasHelp

  • hasHelp(): boolean

hasManual

  • hasManual(): boolean

hasPermission

  • hasPermission(client: TeamSpeakClient): Promise<boolean>

help

isEnabled

  • isEnabled(): boolean

manual

Protected permCheck

  • permCheck(client: TeamSpeakClient): Promise<boolean>

prefix

  • prefix(prefix: string): this
  • 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

validate

  • validate(args: string): object

validateArgs

  • validateArgs(args: string): object
  • Validates the given input string to all added arguments

    Parameters

    • args: string

      the string which should get validated

    Returns object

    • errors: ParseError[]
    • remaining: string
    • result: object

Generated using TypeDoc