Class SlashCommandBuilder<TOpts>

Type Parameters

TOpts

Index

Constructors

Methods

addOption addOptionAttachment addOptionBoolean addOptionChannel addOptionInteger addOptionMentionable addOptionNumber addOptionRole addOptionString addOptionUser build setAckMessageFlags setAckMode setGroup

Constructors

constructor

new SlashCommandBuilder<TOpts>(name, description, options, group?): SlashCommandBuilder<TOpts>
Type Parameters
- TOpts
Parameters
- name: string
- description: string
- options: OptionMap
- Optional group: Group
Returns SlashCommandBuilder<TOpts>
- Defined in src/ts/commands.ts:549

Methods

addOption

addOption<TKey, TKind, TRequired>(name, kind, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: TKind;
required: TRequired;
}>>
Adds a option/argument to this command.

Each type of option has different settings you can adjust, but all of them have a "required" field that defaults to true, you can set it to false for optional options.
Type Parameters
- TKey extends string
- TKind extends "Role" | "String" | "Integer" | "Boolean" | "User" | "Channel" | "Mentionable" | "Number" | "Attachment"
- TRequired extends undefined | boolean
Parameters
- name: TKey
  Name of the option, 1-32 characters (no symbols except - and _)
- kind: TKind
  What type of option this is
- description: string
  Description of the option, 1-100 characters long
- Optional opts: OptionsKindTable[TKind] & BaseOptionSettings<TRequired>
  Additional options, depends on what "kind" you pass but all options has a "required" field that defaults to true
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: TKind;
required: TRequired;
}>>
- Defined in src/ts/commands.ts:677

addOptionAttachment

addOptionAttachment<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Attachment";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: AttachmentOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Attachment";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:661

addOptionBoolean

addOptionBoolean<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Boolean";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: BooleanOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Boolean";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:621

addOptionChannel

addOptionChannel<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Channel";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: ChannelOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Channel";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:637

addOptionInteger

addOptionInteger<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Integer";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: IntegerOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Integer";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:613

addOptionMentionable

addOptionMentionable<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Mentionable";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: MentionableOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Mentionable";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:653

addOptionNumber

addOptionNumber<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Number";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: NumberOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Number";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:597

addOptionRole

addOptionRole<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Role";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: RoleOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Role";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:645

addOptionString

addOptionString<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "String";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: StringOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "String";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:605

addOptionUser

addOptionUser<TKey, TRequired>(name, description, opts?): SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "User";
required: TRequired;
}>>
See addOption
Type Parameters
- TKey extends string
- TRequired extends undefined | boolean
Parameters
- name: TKey
- description: string
- Optional opts: UserOption & BaseOptionSettings<TRequired>
Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "User";
required: TRequired;
}>>
- Defined in src/ts/commands.ts:629

build

build(callback): Command
Build the command, providing a callback that runs when the command gets executed
Parameters
- callback: ((ctx, args) => void | Promise<any>)
  - - (ctx, args): void | Promise<any>
    - Parameters
      ctx: ExecutedCommandContext
      args: ParsedOptionsMap<TOpts>
      Returns void | Promise<any>
Returns Command
The built command, if you used script.createSlashCommand you can ignore the return value but if not you pass it to @{link Script.createCommand} to actually create it on discord
- Defined in src/ts/commands.ts:712

setAckMessageFlags

setAckMessageFlags(flags): SlashCommandBuilder<TOpts>
Sets the flags for the mssage sent when sending the intial interaction response. Epehemeral means that it can only be see by the person issuing the command.
Parameters
- flags: Pick<MessageFlags, "ephemeral" | "suppressEmbeds">
Returns SlashCommandBuilder<TOpts>
- Defined in src/ts/commands.ts:589

setAckMode

setAckMode(mode): SlashCommandBuilder<TOpts>
Set the ack mode of this command (if you're experienced with the discord api, this is the callback type to the interaction)

DeferredMessage: It will respond with a deferred message, using the flags from setAckMessageFlags. Custom: You handle the ack'ing of the interaction yourself, this allows you to use modals.

Keep in mind when using custom, you have to ack the interaction within 3 seconds otherwise it will fail.
Parameters
- mode: AckMode
Returns SlashCommandBuilder<TOpts>
- Defined in src/ts/commands.ts:580

setGroup

setGroup(group): SlashCommandBuilder<TOpts>

Assigns a group to this command

Parameters

group: Group

Returns SlashCommandBuilder<TOpts>

Example

const group = new Commands.Group("some-group", "some description")
script.addCommand(Commands.slashCommand("some-cmd", "some description").setGroup(grou).build(...))

Class SlashCommandBuilder<TOpts>

Type Parameters

TOpts

Index

Constructors

Methods

Constructors

constructor

Type Parameters

TOpts

Parameters

name: string

description: string

options: OptionMap

Optional group: Group

Returns SlashCommandBuilder<TOpts>

Methods

addOption

Type Parameters

TKey extends string

TKind extends "Role" | "String" | "Integer" | "Boolean" | "User" | "Channel" | "Mentionable" | "Number" | "Attachment"

TRequired extends undefined | boolean

Parameters

name: TKey

kind: TKind

description: string

Optional opts: OptionsKindTable[TKind] & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: TKind; required: TRequired; }>>

addOptionAttachment

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

Optional opts: AttachmentOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: "Attachment"; required: TRequired; }>>

addOptionBoolean

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

Optional opts: BooleanOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: "Boolean"; required: TRequired; }>>

addOptionChannel

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

Optional opts: ChannelOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: "Channel"; required: TRequired; }>>

addOptionInteger

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

Optional opts: IntegerOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: "Integer"; required: TRequired; }>>

addOptionMentionable

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

Optional opts: MentionableOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, { kind: "Mentionable"; required: TRequired; }>>

addOptionNumber

Type Parameters

TKey extends string

TRequired extends undefined | boolean

Parameters

name: TKey

description: string

`Optional` group: Group

`Optional` opts: OptionsKindTable[TKind] & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: TKind;
required: TRequired;
}>>

`Optional` opts: AttachmentOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Attachment";
required: TRequired;
}>>

`Optional` opts: BooleanOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Boolean";
required: TRequired;
}>>

`Optional` opts: ChannelOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Channel";
required: TRequired;
}>>

`Optional` opts: IntegerOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Integer";
required: TRequired;
}>>

`Optional` opts: MentionableOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Mentionable";
required: TRequired;
}>>

`Optional` opts: NumberOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Number";
required: TRequired;
}>>

`Optional` opts: RoleOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "Role";
required: TRequired;
}>>

`Optional` opts: StringOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "String";
required: TRequired;
}>>

`Optional` opts: UserOption & BaseOptionSettings<TRequired>

Returns SlashCommandBuilder<LayerOption<TOpts, TKey, {
kind: "User";
required: TRequired;
}>>