ArgBuilder<T, N, R, C>
Defined in: packages/client/src/commands/args.ts:45
Declares one command argument: chain setName, setDescription, type-specific setters, then build().
Type Parameters
T
T extends ArgType
N
N extends string = string
R
R extends boolean = false
C
C extends string = string
Constructors
Constructor
new ArgBuilder<T, N, R, C>(type): ArgBuilder<T, N, R, C>;Defined in: packages/client/src/commands/args.ts:54
Parameters
type
T
Argument type
Returns
ArgBuilder<T, N, R, C>
Methods
build()
build(): object;Defined in: packages/client/src/commands/args.ts:142
Returns
object
definition
definition: ArgDefinition;problems
problems: string[];setChoices()
setChoices<C2>(this, ...choices): ArgBuilder<"choice", N, R, C2>;Defined in: packages/client/src/commands/args.ts:134
Type Parameters
C2
C2 extends string
Parameters
this
ArgBuilder<"choice", N, R, C>
choices
...C2[]
Accepted values
Returns
ArgBuilder<"choice", N, R, C2>
setDefault()
setDefault(value): ArgBuilder<T, N, true, C>;Defined in: packages/client/src/commands/args.ts:91
Parameters
value
ArgValue<T, C>
Used when the argument is omitted, makes it optional
Returns
ArgBuilder<T, N, true, C>
setDescription()
setDescription(description): this;Defined in: packages/client/src/commands/args.ts:79
Parameters
description
string
Free text for the bot author
Returns
this
setMax()
setMax(this, max): ArgBuilder<T, N, R, C>;Defined in: packages/client/src/commands/args.ts:128
Parameters
this
ArgBuilder<"number" | "integer", N, R, C>
max
number
Maximum value
Returns
ArgBuilder<T, N, R, C>
setMaxLength()
setMaxLength(this, length): ArgBuilder<"string", N, R, C>;Defined in: packages/client/src/commands/args.ts:104
Parameters
this
ArgBuilder<"string", N, R, C>
length
number
Maximum length in characters
Returns
ArgBuilder<"string", N, R, C>
setMin()
setMin(this, min): ArgBuilder<T, N, R, C>;Defined in: packages/client/src/commands/args.ts:122
Parameters
this
ArgBuilder<"number" | "integer", N, R, C>
min
number
Minimum value
Returns
ArgBuilder<T, N, R, C>
setMinLength()
setMinLength(this, length): ArgBuilder<"string", N, R, C>;Defined in: packages/client/src/commands/args.ts:98
Parameters
this
ArgBuilder<"string", N, R, C>
length
number
Minimum length in characters
Returns
ArgBuilder<"string", N, R, C>
setName()
setName<N2>(name): ArgBuilder<T, N2, R, C>;Defined in: packages/client/src/commands/args.ts:73
Type Parameters
N2
N2 extends string
Parameters
name
N2
Lowercase, letters digits and _, 1 to 32 characters
Returns
ArgBuilder<T, N2, R, C>
setPattern()
setPattern(this, pattern): ArgBuilder<"string", N, R, C>;Defined in: packages/client/src/commands/args.ts:110
Parameters
this
ArgBuilder<"string", N, R, C>
pattern
RegExp
Regular expression the value must match
Returns
ArgBuilder<"string", N, R, C>
setRequired()
setRequired<R2>(required?): ArgBuilder<T, N, R2, C>;Defined in: packages/client/src/commands/args.ts:85
Type Parameters
R2
R2 extends boolean = true
Parameters
required?
R2 = ...
Default true
Returns
ArgBuilder<T, N, R2, C>
setRest()
setRest(this, rest?): ArgBuilder<"string", N, R, C>;Defined in: packages/client/src/commands/args.ts:116
Parameters
this
ArgBuilder<"string", N, R, C>
rest?
boolean = true
Take the rest of the line. Only for the last argument
Returns
ArgBuilder<"string", N, R, C>