Class InteractionCommandOption<ParsedArgsFinished>

Type parameters

ParsedArgsFinished = ParsedArgs

Hierarchy

Structure
- InteractionCommandOption

Index

Constructors

constructor

Accessors

Constructors

constructor

new InteractionCommandOption<ParsedArgsFinished>(data?: InteractionCommandOptionOptions): InteractionCommandOption<ParsedArgsFinished>

Overrides Structure.constructor
- Defined in src/interaction/command.ts:526
Type parameters
- ParsedArgsFinished = ParsedArgs
Parameters
- data: InteractionCommandOptionOptions = {}
Returns InteractionCommandOption<ParsedArgsFinished>

Properties

Optional Readonly _file

_file: string

Readonly _keys

_keys: BaseSet<string> = ...

Optional _options

_options: BaseCollection<string, InteractionCommandOption<ParsedArgs>>

Optional choices

choices: InteractionCommandOptionChoice[]

Optional default

default: any

description

description: string = ''

Optional disableDm

disableDm: boolean

Optional label

label: string

metadata

metadata: Record<string, any> = {}

name

name: string = ''

Optional Readonly parent

parent: InteractionCommand<ParsedArgs> | InteractionCommandOption<ParsedArgs>

Optional permissions

permissions: bigint[]

Optional permissionsClient

permissionsClient: bigint[]

Optional permissionsIgnoreClientOwner

permissionsIgnoreClientOwner: boolean

Optional ratelimits

ratelimits: CommandRatelimit[]

Optional required

required: boolean

Optional triggerLoadingAfter

triggerLoadingAfter: number

Optional triggerLoadingAsEphemeral

triggerLoadingAsEphemeral: boolean

type

type: ApplicationCommandOptionTypes = ...

Optional value

value: ArgumentConverter

Accessors

_choicesKey

get _choicesKey(): string

- Defined in src/interaction/command.ts:599
Returns string

_optionsKey

get _optionsKey(): string

- Defined in src/interaction/command.ts:603
Returns string

fullName

get fullName(): string

- Defined in src/interaction/command.ts:607
Returns string

hasRun

get hasRun(): boolean

- Defined in src/interaction/command.ts:614
Returns boolean

isSubCommand

get isSubCommand(): boolean

- Defined in src/interaction/command.ts:626
Returns boolean

isSubCommandGroup

get isSubCommandGroup(): boolean

- Defined in src/interaction/command.ts:630
Returns boolean

key

get key(): string

- Defined in src/interaction/command.ts:634
Returns string

length

get length(): number

- Defined in src/interaction/command.ts:638
Returns number

lengthChoices

get lengthChoices(): number

- Defined in src/interaction/command.ts:642
Returns number

lengthOptions

get lengthOptions(): number

- Defined in src/interaction/command.ts:654
Returns number

options

get options(): undefined | InteractionCommandOption<ParsedArgs>[]
set options(value: undefined | InteractionCommandOption<ParsedArgs>[]): void

- Defined in src/interaction/command.ts:663
Returns undefined | InteractionCommandOption<ParsedArgs>[]
- Defined in src/interaction/command.ts:667
Parameters
- value: undefined | InteractionCommandOption<ParsedArgs>[]
Returns void

Methods

[custom]

[custom](): object

Inherited from Structure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from Structure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

_transferValuesToChildren

_transferValuesToChildren(parent: InteractionCommand<ParsedArgs> | InteractionCommandOption<ParsedArgs>): void

- Defined in src/interaction/command.ts:767
Parameters
- parent: InteractionCommand<ParsedArgs> | InteractionCommandOption<ParsedArgs>
Returns void

addChoice

addChoice(name: InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions): InteractionCommandOptionChoice
addChoice(name: string, value: string | number): InteractionCommandOptionChoice

- Defined in src/interaction/command.ts:705
Parameters
- name: InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions
Returns InteractionCommandOptionChoice
- Defined in src/interaction/command.ts:706
Parameters
- name: string
- value: string | number
Returns InteractionCommandOptionChoice

addOption

addOption(value: InteractionCommandOption<ParsedArgs> | InteractionCommandOptionOptions | typeof InteractionCommandOption): InteractionCommandOption<ParsedArgs>

- Defined in src/interaction/command.ts:721
Parameters
- value: InteractionCommandOption<ParsedArgs> | InteractionCommandOptionOptions | typeof InteractionCommandOption
Returns InteractionCommandOption<ParsedArgs>

difference

difference(key: string, value: any): [boolean, any]

Inherited from Structure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from Structure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from Structure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

getInvoker

getInvoker(option: InteractionDataApplicationCommandOption): null | InteractionCommandOption<ParsedArgs>

- Defined in src/interaction/command.ts:685
Parameters
- option: InteractionDataApplicationCommandOption
Returns null | InteractionCommandOption<ParsedArgs>

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from Structure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides Structure.mergeValue
- Defined in src/interaction/command.ts:800
Parameters
- key: string
- value: any
Returns void

Optional onBefore

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

- Defined in src/interaction/command.ts:515
Parameters
- context: InteractionContext
Returns boolean | Promise<boolean>

Optional onBeforeRun

onBeforeRun(context: InteractionContext, args: ParsedArgs): boolean | Promise<boolean>

- Defined in src/interaction/command.ts:516
Parameters
- context: InteractionContext
- args: ParsedArgs
Returns boolean | Promise<boolean>

Optional onCancel

onCancel(context: InteractionContext): any

- Defined in src/interaction/command.ts:517
Parameters
- context: InteractionContext
Returns any

Optional onCancelRun

onCancelRun(context: InteractionContext, args: ParsedArgs): any

- Defined in src/interaction/command.ts:518
Parameters
- context: InteractionContext
- args: ParsedArgs
Returns any

Optional onDmBlocked

onDmBlocked(context: InteractionContext): any

- Defined in src/interaction/command.ts:513
Parameters
- context: InteractionContext
Returns any

Optional onError

onError(context: InteractionContext, args: ParsedArgs, error: any): any

- Defined in src/interaction/command.ts:519
Parameters
- context: InteractionContext
- args: ParsedArgs
- error: any
Returns any

Optional onLoadingTrigger

onLoadingTrigger(context: InteractionContext): any

- Defined in src/interaction/command.ts:514
Parameters
- context: InteractionContext
Returns any

Optional onPermissionsFail

onPermissionsFail(context: InteractionContext, permissions: FailedPermissions): any

- Defined in src/interaction/command.ts:520
Parameters
- context: InteractionContext
- permissions: FailedPermissions
Returns any

Optional onPermissionsFailClient

onPermissionsFailClient(context: InteractionContext, permissions: FailedPermissions): any

- Defined in src/interaction/command.ts:521
Parameters
- context: InteractionContext
- permissions: FailedPermissions
Returns any

Optional onRatelimit

onRatelimit(context: InteractionContext, ratelimits: CommandRatelimitInfo[], metadata: CommandRatelimitMetadata): any

- Defined in src/interaction/command.ts:522
Parameters
- context: InteractionContext
- ratelimits: CommandRatelimitInfo[]
- metadata: CommandRatelimitMetadata
Returns any

Optional onRunError

onRunError(context: InteractionContext, args: ParsedArgsFinished, error: any): any

- Defined in src/interaction/command.ts:524
Parameters
- context: InteractionContext
- args: ParsedArgsFinished
- error: any
Returns any

Optional onSuccess

onSuccess(context: InteractionContext, args: ParsedArgsFinished): any

- Defined in src/interaction/command.ts:525
Parameters
- context: InteractionContext
- args: ParsedArgsFinished
Returns any

Optional onValueError

onValueError(context: InteractionContext, args: ParsedArgs, errors: ParsedErrors): any

- Defined in src/interaction/command.ts:526
Parameters
- context: InteractionContext
- args: ParsedArgs
- errors: ParsedErrors
Returns any

Optional run

run(context: InteractionContext, args: ParsedArgsFinished): any

- Defined in src/interaction/command.ts:523
Parameters
- context: InteractionContext
- args: ParsedArgsFinished
Returns any

setChoices

setChoices(value?: (InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions)[]): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:737
Parameters
- value: (InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions)[] = []
Returns InteractionCommandOption<ParsedArgsFinished>

setDescription

setDescription(value: string): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:742
Parameters
- value: string
Returns InteractionCommandOption<ParsedArgsFinished>

setName

setName(value: string): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:747
Parameters
- value: string
Returns InteractionCommandOption<ParsedArgsFinished>

setOptions

setOptions(value?: (InteractionCommandOption<ParsedArgs> | InteractionCommandOptionOptions)[]): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:752
Parameters
- value: (InteractionCommandOption<ParsedArgs> | InteractionCommandOptionOptions)[] = []
Returns InteractionCommandOption<ParsedArgsFinished>

setRequired

setRequired(value: boolean): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:757
Parameters
- value: boolean
Returns InteractionCommandOption<ParsedArgsFinished>

setType

setType(value: ApplicationCommandOptionTypes): InteractionCommandOption<ParsedArgsFinished>

- Defined in src/interaction/command.ts:762
Parameters
- value: ApplicationCommandOptionTypes
Returns InteractionCommandOption<ParsedArgsFinished>

toJSON

toJSON(): object

Inherited from Structure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc