Argumentclass

Command Argument

On this page

Overview
Constructor1
Properties8
Accessors5
Methods6

Command Argument

import { Command } from 'detritus-client';

Command.Argument;

13 properties6 methodssrc/command/argument.ts:40

Constructor

new Argument

src/command/argument.ts:56

new Argument(options: ArgumentOptions)

Properties

choices?

any[]

optional

consume?

boolean

optional

Default false

default

any

Default undefined

help

string

Default ''

metadata?

{ [key: string]: any }

optional

positionalArgs?

ArgumentParser

optional

prefixes

Set<string>

required

boolean

Default false

Accessors

aliases

string[]

get · set

label

string

get · set

name

string

get · set

names

string[]

get

type

ArgumentType

get · set

Methods

check()

src/command/argument.ts:160

check(name: string): boolean

getDefault()

async src/command/argument.ts:187

getDefault(context: Context): Promise<any>

getInfo()

src/command/argument.ts:164

getInfo(content: string): { index: number; name: string }

getName()

src/command/argument.ts:194

getName(content: string): string | null

parse()

async src/command/argument.ts:267

parse(value: string, context: Context): Promise<any>

setPrefixes()

src/command/argument.ts:243

setPrefixes(prefixes: string[], prefixSpace?: boolean): void

Parameters

prefixes

string[]

prefixSpace?

boolean

Default false