Command<ParsedArgsFinished>class

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

On this page

Overview
Constructor1
Properties15
Accessors11
Methods27

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

import { Command } from 'detritus-client';

Command.Command;

Type parameters

25 properties27 methodssrc/command/command.ts:135

Constructor

new Command

src/command/command.ts:170

new Command<ParsedArgsFinished = any>(
  commandClient: CommandClient,
  options: CommandOptions,
)

Properties

_file?

string

readonlyoptional

arg

Argument

argParser

ArgumentParser

readonly

commandClient

CommandClient

readonly

disableDm

boolean

Default false

disableDmReply

boolean

Default false

metadata

Record<string, any>

Default {}

permissions?

bigint[]

optional

permissionsClient?

bigint[]

optional

permissionsIgnoreClientOwner?

boolean

optional

Default false

priority

number

Default 0

ratelimits

CommandRatelimit[]

Default []

responseOptional

boolean

Default false

triggerTypingAfter

number

Default -1

triggerTypingOnEdits

boolean

Default false

Accessors

aliases

string[]

get · set

args

ArgumentOptions[]

set

choices

any[] | undefined

get · set

default

any

get · set

fullName

string

get

help

string

get · set

label

string

get · set

name

string

get · set

names

string[]

get

prefixes

string[]

set

type

ArgumentType

set

Methods

check()

src/command/command.ts:353

check(name: string): boolean

getArgs()

async src/command/command.ts:357

getArgs(
  attributes: CommandAttributes,
  context: Context,
): Promise<{ errors: any; parsed: any }>

getName()

src/command/command.ts:396

getName(content: string): string | null

onBefore()

optional src/command/command.ts:155

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

onBeforeRun()

optional src/command/command.ts:156

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

onCancel()

optional src/command/command.ts:157

onCancel(context: Context): void | Message | Promise<void | Message>

onCancelRun()

optional src/command/command.ts:158

onCancelRun(context: Context, args: any): void | Message | Promise<void | Message>

onDmBlocked()

optional src/command/command.ts:154

onDmBlocked(context: Context): void | Message | Promise<void | Message>

onError()

optional src/command/command.ts:159

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

onFinally()

optional src/command/command.ts:160

onFinally(context: Context): unknown

onPermissionsFail()

optional src/command/command.ts:161

onPermissionsFail(
  context: Context,
  permissions: FailedPermissions,
): void | Message | Promise<void | Message>

onPermissionsFailClient()

optional src/command/command.ts:162

onPermissionsFailClient(
  context: Context,
  permissions: FailedPermissions,
): void | Message | Promise<void | Message>

onRatelimit()

optional src/command/command.ts:163

onRatelimit(
  context: Context,
  ratelimits: CommandRatelimitInfo[],
  metadata: CommandRatelimitMetadata,
): void | Message | Promise<void | Message>

onRunError()

optional src/command/command.ts:165

onRunError(
  context: Context,
  args: ParsedArgsFinished,
  error: any,
): void | Message | Promise<void | Message>

onSuccess()

optional src/command/command.ts:166

onSuccess(context: Context, args: ParsedArgsFinished): unknown

onTypeError()

optional src/command/command.ts:167

onTypeError(
  context: Context,
  args: any,
  errors: any,
): void | Message | Promise<void | Message>

onTypingTrigger()

optional src/command/command.ts:168

onTypingTrigger(context: Context): unknown

run()

optional src/command/command.ts:164

run(context: Context, args: ParsedArgsFinished): void | Message | Promise<void | Message>

setAliases()

src/command/command.ts:308

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

setArgs()

src/command/command.ts:313

setArgs(value: ArgumentOptions[]): Command<ParsedArgsFinished>

setChoices()

src/command/command.ts:318

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

setDefault()

src/command/command.ts:323

setDefault(value: any): Command<ParsedArgsFinished>

setHelp()

src/command/command.ts:328

setHelp(value: string): Command<ParsedArgsFinished>

setLabel()

src/command/command.ts:333

setLabel(value: string): Command<ParsedArgsFinished>

setName()

src/command/command.ts:338

setName(value: string): Command<ParsedArgsFinished>

setPrefixes()

src/command/command.ts:343

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

setType()

src/command/command.ts:348

setType(value: ArgumentType): this