InteractionCommand | Detritus Client

Type parameters

ParsedArgsFinished = ParsedArgs

Hierarchy

Structure
- InteractionCommand

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new InteractionCommand<ParsedArgsFinished>(data?: InteractionCommandOptions): InteractionCommand<ParsedArgsFinished>

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

Properties

Optional Readonly _file

_file: string

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysSkipDifference

_keysSkipDifference: BaseSet<string> = ...

Optional _options

_options: BaseCollection<string, InteractionCommandOption<ParsedArgs>>

defaultPermission

defaultPermission: boolean = true

description

description: string = ''

Optional disableDm

disableDm: boolean

global

global: boolean = true

Optional guildIds

guildIds: BaseSet<string>

ids

ids: BaseCollection<string, string> = ...

metadata

metadata: Record<string, any> = {}

name

name: string = ''

Optional permissions

permissions: bigint[]

Optional permissionsClient

permissionsClient: bigint[]

Optional permissionsIgnoreClientOwner

permissionsIgnoreClientOwner: boolean

ratelimits

ratelimits: CommandRatelimit[] = []

Optional triggerLoadingAfter

triggerLoadingAfter: number

Optional triggerLoadingAsEphemeral

triggerLoadingAsEphemeral: boolean

type

type: ApplicationCommandTypes = ...

Accessors

_optionsKey

get _optionsKey(): string

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

fullName

get fullName(): string

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

hasRun

get hasRun(): boolean

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

hash

get hash(): string

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

isContextCommand

get isContextCommand(): boolean

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

isContextCommandMessage

get isContextCommandMessage(): boolean

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

isContextCommandUser

get isContextCommandUser(): boolean

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

isGroup

get isGroup(): boolean

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

isSlashCommand

get isSlashCommand(): boolean

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

key

get key(): string

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

length

get length(): number

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

lengthOptions

get lengthOptions(): number

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

options

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

- Defined in src/interaction/command.ts:393
Returns undefined | InteractionCommandOption<ParsedArgs>[]
- Defined in src/interaction/command.ts:397
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(): void

- Defined in src/interaction/command.ts:438
Returns void

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(data: InteractionDataApplicationCommand): null | InteractionCommandInvoker

- Defined in src/interaction/command.ts:411
Parameters
- data: InteractionDataApplicationCommand
Returns null | InteractionCommandInvoker

getInvokerOption

getInvokerOption(options: BaseCollection<string, InteractionDataApplicationCommandOption>): null | InteractionCommandOption<ParsedArgs>

- Defined in src/interaction/command.ts:421
Parameters
- options: BaseCollection<string, 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:446
Parameters
- key: string
- value: any
Returns void

Optional onBefore

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

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

Optional onBeforeRun

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

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

Optional onCancel

onCancel(context: InteractionContext): any

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

Optional onCancelRun

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

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

Optional onDmBlocked

onDmBlocked(context: InteractionContext): any

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

Optional onError

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

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

Optional onLoadingTrigger

onLoadingTrigger(context: InteractionContext): any

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

Optional onPermissionsFail

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

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

Optional onPermissionsFailClient

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

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

Optional onRatelimit

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

- Defined in src/interaction/command.ts:266
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:268
Parameters
- context: InteractionContext
- args: ParsedArgsFinished
- error: any
Returns any

Optional onSuccess

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

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

Optional onValueError

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

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

Optional run

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

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

toJSON

toJSON(): object

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

Type parameters

ParsedArgsFinished = ParsedArgs

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

ParsedArgsFinished = ParsedArgs

Parameters

data: InteractionCommandOptions = {}

Returns InteractionCommand<ParsedArgsFinished>

Properties

Optional Readonly _file

Readonly _keys

Readonly _keysSkipDifference

Optional _options

defaultPermission

description

Optional disableDm

global

Optional guildIds

ids

metadata

name

Optional permissions

Optional permissionsClient

Optional permissionsIgnoreClientOwner

ratelimits

Optional triggerLoadingAfter

Optional triggerLoadingAsEphemeral

type

Accessors

_optionsKey

Returns string

fullName

Returns string

hasRun

Returns boolean

hash

Returns string

isContextCommand

Returns boolean

isContextCommandMessage

Returns boolean

isContextCommandUser

Returns boolean

isGroup

Returns boolean

isSlashCommand

Returns boolean

key

Returns string

length

Returns number

lengthOptions

Returns number

options

Returns undefined | InteractionCommandOption<ParsedArgs>[]

Parameters

value: undefined | InteractionCommandOption<ParsedArgs>[]

Returns void

Methods

[custom]

Returns object

_getFromSnake

Parameters

key: string

Returns any

_setFromSnake

Parameters

key: string

value: any

Returns any

_transferValuesToChildren

Returns void

difference