Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Command<ParsedArgsFinished>

Command itself Command flow is ratelimit check -> dm/permission check -> onBefore -> arg parse -> onBeforeRun -> run -> onSuccess | onRunError

Type parameters

Hierarchy

  • Command

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional Readonly _file

_file: string

arg

arg: Argument

Readonly argParser

argParser: ArgumentParser = ...

Readonly commandClient

commandClient: CommandClient

disableDm

disableDm: boolean = false

disableDmReply

disableDmReply: boolean = false

metadata

metadata: Record<string, any> = {}

Optional permissions

permissions: bigint[]

Optional permissionsClient

permissionsClient: bigint[]

Optional permissionsIgnoreClientOwner

permissionsIgnoreClientOwner: boolean = false

priority

priority: number = 0

ratelimits

ratelimits: CommandRatelimit[] = []

responseOptional

responseOptional: boolean = false

triggerTypingAfter

triggerTypingAfter: number = -1

Accessors

aliases

  • get aliases(): string[]
  • set aliases(value: string[]): void

args

choices

  • get choices(): undefined | any[]
  • set choices(value: undefined | any[]): void

default

  • get default(): any
  • set default(value: any): void

fullName

  • get fullName(): string

help

  • get help(): string
  • set help(value: string): void

label

  • get label(): string
  • set label(value: string): void

name

  • get name(): string
  • set name(value: string): void

names

  • get names(): string[]

prefixes

  • set prefixes(value: string[]): void

type

Methods

check

  • check(name: string): boolean

getArgs

getName

  • getName(content: string): null | string

Optional onBefore

  • onBefore(context: Context): boolean | Promise<boolean>

Optional onBeforeRun

  • onBeforeRun(context: Context, args: any): boolean | Promise<boolean>

Optional onCancel

Optional onCancelRun

  • onCancelRun(context: Context, args: any): any

Optional onDmBlocked

  • onDmBlocked(context: Context): any

Optional onError

  • onError(context: Context, args: any, error: any): any

Optional onPermissionsFail

Optional onPermissionsFailClient

Optional onRatelimit

Optional onRunError

  • onRunError(context: Context, args: ParsedArgsFinished, error: any): any

Optional onSuccess

  • onSuccess(context: Context, args: ParsedArgsFinished): any

Optional onTypeError

  • onTypeError(context: Context, args: any, errors: any): any

Optional run

  • run(context: Context, args: ParsedArgsFinished): any

setAliases

  • setAliases(value: string[]): Command<ParsedArgsFinished>

setArgs

setChoices

  • setChoices(value: undefined | any[]): Command<ParsedArgsFinished>

setDefault

  • setDefault(value: any): Command<ParsedArgsFinished>

setHelp

  • setHelp(value: string): Command<ParsedArgsFinished>

setLabel

  • setLabel(value: string): Command<ParsedArgsFinished>

setName

  • setName(value: string): Command<ParsedArgsFinished>

setPrefixes

  • setPrefixes(value: string[]): Command<ParsedArgsFinished>

setType

Generated using TypeDoc