CommandBuilder<Args>
Defined in: packages/client/src/commands/command-builder.ts:36
Declares a command. Chain setName, setDescription, addArg…, setHandler, then build() — which throws
a LoadError listing every problem. Triggered by /name in DM and @Bot name on channels; this rule is
fixed.
Type Parameters
Args
Args extends object = {
}
Implements
Constructors
Constructor
new CommandBuilder<Args>(options?): CommandBuilder<Args>;Defined in: packages/client/src/commands/command-builder.ts:52
Parameters
options?
core marks a built-in command that may use a reserved name
core?
boolean
Returns
CommandBuilder<Args>
Properties
[BRICK]
readonly [BRICK]: "command";Defined in: packages/client/src/commands/command-builder.ts:37
Implementation of
Methods
addAliases()
addAliases(...aliases): this;Defined in: packages/client/src/commands/command-builder.ts:69
Parameters
aliases
...string[]
Alternative names, same rules as the name
Returns
this
addBooleanArg()
addBooleanArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? boolean : boolean | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:96
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"boolean", N, R>
Receives the boolean argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? boolean : boolean | undefined })[K] }>
addChannelArg()
addChannelArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Channel : Channel | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:124
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"channel", N, R>
Receives the channel argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Channel : Channel | undefined })[K] }>
addChoiceArg()
addChoiceArg<N, R, C>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? C : C | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:103
Type Parameters
N
N extends string
R
R extends boolean
C
C extends string
Parameters
configure
(arg) => ArgBuilder<"choice", N, R, C>
Receives the choice argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? C : C | undefined })[K] }>
addContactArg()
addContactArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Contact : Contact | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:110
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"contact", N, R>
Receives the contact argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Contact : Contact | undefined })[K] }>
addIntegerArg()
addIntegerArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? number : number | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:82
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"integer", N, R>
Receives the integer argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? number : number | undefined })[K] }>
addNumberArg()
addNumberArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? number : number | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:89
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"number", N, R>
Receives the number argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? number : number | undefined })[K] }>
addRoleArg()
addRoleArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Role : Role | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:117
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"role", N, R>
Receives the role argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? Role : Role | undefined })[K] }>
addStringArg()
addStringArg<N, R>(configure): CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? string : string | undefined })[K] }>;Defined in: packages/client/src/commands/command-builder.ts:75
Type Parameters
N
N extends string
R
R extends boolean
Parameters
configure
(arg) => ArgBuilder<"string", N, R>
Receives the string argument builder and returns it
Returns
CommandBuilder<{ [K in string | number | symbol]: (Args & { [K in string]: R extends true ? string : string | undefined })[K] }>
build()
build(): CommandDefinition;Defined in: packages/client/src/commands/command-builder.ts:172
Returns
Implementation of
setCooldown()
setCooldown(seconds): this;Defined in: packages/client/src/commands/command-builder.ts:137
Parameters
seconds
number
Delay between two runs by the same author. Default 0
Returns
this
setDescription()
setDescription(description): this;Defined in: packages/client/src/commands/command-builder.ts:63
Parameters
description
string
Free text for the bot author
Returns
this
setErrorHandler()
setErrorHandler(handler): this;Defined in: packages/client/src/commands/command-builder.ts:161
Parameters
handler
Builds the reply when the handler throws
Returns
this
setHandler()
setHandler(handler): this;Defined in: packages/client/src/commands/command-builder.ts:167
Parameters
handler
(ctx) => unknown
Runs the command with its typed context
Returns
this
setMaxAge()
setMaxAge(seconds): this;Defined in: packages/client/src/commands/command-builder.ts:143
Parameters
seconds
number
Backlog messages older than this are ignored. Default 300
Returns
this
setName()
setName(name): this;Defined in: packages/client/src/commands/command-builder.ts:57
Parameters
name
string
Lowercase, letters digits _ and -, 1 to 32 characters
Returns
this
setRequiredPermissions()
setRequiredPermissions(...permissions): this;Defined in: packages/client/src/commands/command-builder.ts:149
Parameters
permissions
...PermissionLike[]
Permissions the author needs, all of them
Returns
this
setScope()
setScope(...scopes): this;Defined in: packages/client/src/commands/command-builder.ts:131
Parameters
scopes
...CommandScope[]
dm, channel or both. Default both
Returns
this
setUsageErrorHandler()
setUsageErrorHandler(handler): this;Defined in: packages/client/src/commands/command-builder.ts:155
Parameters
handler
Builds the reply to an invalid argument
Returns
this