Documentation/detritus-client/Interaction

InteractionCommandOption<ParsedArgsFinished>class

The most basic Structure class, every structure extends this

On this page

Overview
Constructor1
Properties28
Accessors10
Methods41

The most basic Structure class, every structure extends this

import { Interaction } from 'detritus-client';

Interaction.InteractionCommandOption;

Hierarchy

StructureInteractionCommandOption

Type parameters

36 properties28 methods11 inheritedsrc/interaction/command.ts:681

Constructor

new InteractionCommandOption

src/interaction/command.ts:733

new InteractionCommandOption<ParsedArgsFinished = ParsedArgs>(
  data?: InteractionCommandOptionOptions,
)

Properties

_file?

string

readonlyoptional

_options?

BaseCollection<string, InteractionCommandOption<ParsedArgs>>

optional

autocomplete?

boolean

optional

channelTypes?

number[]

optional

choices?

InteractionCommandOptionChoice[]

optional

default?

any

optional

description

string

Default ''

descriptionLocalizations

Record<string, string | undefined> | null

Default null

disableDm?

boolean

optional

fileTypes?

string[]

optional

label?

string

optional

maxLength?

number

optional

maxValue?

number | bigint

optional

metadata

Record<string, any>

Default {}

minLength?

number

optional

minValue?

number | bigint

optional

name

string

Default ''

nameLocalizations

Record<string, string | undefined> | null

Default null

parent?

InteractionCommandOption<ParsedArgs> | InteractionCommand<ParsedArgs>

readonlyoptional

permissions?

bigint[]

optional

permissionsClient?

bigint[]

optional

permissionsIgnoreClientOwner?

boolean

optional

ratelimits?

CommandRatelimit[]

optional

required?

boolean

optional

triggerLoadingAfter?

number

optional

triggerLoadingAsEphemeral?

boolean

optional

type

ApplicationCommandOptionTypes

Default ApplicationCommandOptionTypes.STRING

value?

ArgumentConverter

optional

Accessors

fullName

string

get

hasRun

boolean

get

invokers

InteractionCommandOption<ParsedArgs>[]

get

isSubCommand

boolean

get

isSubCommandGroup

boolean

get

key

string

get

length

number

get

lengthChoices

number

get

lengthOptions

number

get

options

InteractionCommandOption<ParsedArgs>[] | undefined

get · set

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from Structure._setFromSnake

_setTypeFromOptions()

src/interaction/command.ts:1028

_setTypeFromOptions(): void

_transferValuesToChildren()

src/interaction/command.ts:1038

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

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

addChoice()

src/interaction/command.ts:964

addChoice(
  name: InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions,
): InteractionCommandOptionChoice

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

addOption()

src/interaction/command.ts:980

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

difference()

src/structures/basestructure.ts:146

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

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

getInvoker()

src/interaction/command.ts:920

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

getInvokerForAutoComplete()

src/interaction/command.ts:940

getInvokerForAutoComplete(
  option: InteractionDataApplicationCommandOption,
): InteractionCommandOption<ParsedArgs> | null

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from Structure.merge

mergeValue()

src/interaction/command.ts:1078

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

Overrides Structure.mergeValue

onAutoComplete()

optional src/interaction/command.ts:715

onAutoComplete(context: InteractionAutoCompleteContext): unknown

onAutoCompleteError()

optional src/interaction/command.ts:716

onAutoCompleteError(context: InteractionAutoCompleteContext, error: any): unknown

onBefore()

optional src/interaction/command.ts:719

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

onBeforeRun()

optional src/interaction/command.ts:720

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

onCancel()

optional src/interaction/command.ts:721

onCancel(context: InteractionContext): unknown

onCancelRun()

optional src/interaction/command.ts:722

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

onDmBlocked()

optional src/interaction/command.ts:717

onDmBlocked(context: InteractionContext): unknown

onError()

optional src/interaction/command.ts:723

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

onFinally()

optional src/interaction/command.ts:724

onFinally(context: InteractionContext): unknown

onLoadingTrigger()

optional src/interaction/command.ts:718

onLoadingTrigger(context: InteractionContext): unknown

onPermissionsFail()

optional src/interaction/command.ts:725

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

onPermissionsFailClient()

optional src/interaction/command.ts:726

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

onRatelimit()

optional src/interaction/command.ts:727

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

onRunError()

optional src/interaction/command.ts:729

onRunError(context: InteractionContext, args: ParsedArgs, error: any): unknown

onSuccess()

optional src/interaction/command.ts:730

onSuccess(context: InteractionContext, args: ParsedArgs): unknown

onValueError()

optional src/interaction/command.ts:731

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

run()

optional src/interaction/command.ts:728

run(context: InteractionContext, args: ParsedArgs): unknown

setChoices()

src/interaction/command.ts:998

setChoices(
  value?: (InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions)[],
): this

Parameters

value?

(InteractionCommandOptionChoice | InteractionCommandOptionChoiceOptions)[]

Default []

setDescription()

src/interaction/command.ts:1003

setDescription(value: string): this

setName()

src/interaction/command.ts:1008

setName(value: string): this

setOptions()

src/interaction/command.ts:1013

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

Parameters

value?

(InteractionCommandOption<ParsedArgs> | InteractionCommandOptionOptions)[]

Default []

setRequired()

src/interaction/command.ts:1018

setRequired(value: boolean): this

setType()

src/interaction/command.ts:1023

setType(value: ApplicationCommandOptionTypes): this

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from Structure.toJSON