InteractionCommandClient | Detritus Client

Interaction Command Client, hooks onto a ClusterClient or ShardClient to provide easier command handling Flow is onInteractionCheck -> onCommandCheck

Hierarchy

EventSpewer
- InteractionCommandClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new InteractionCommandClient(token: string | ClusterClient | CommandClient | ShardClient, options?: InteractionCommandClientOptions): InteractionCommandClient

Overrides EventSpewer.constructor
- Defined in src/interactioncommandclient.ts:107
Parameters
- token: string | ClusterClient | CommandClient | ShardClient
- options: InteractionCommandClientOptions = {}
Returns InteractionCommandClient

Properties

Readonly _clientSubscriptions

_clientSubscriptions: EventSubscription[] = []

checkCommands

checkCommands: boolean = true

directories

directories: BaseCollection<string, { subdirectories: boolean }> = ...

ran

ran: boolean = false

ratelimiter

ratelimiter: CommandRatelimiter

ratelimits

ratelimits: CommandRatelimit[] = []

strictCommandCheck

strictCommandCheck: boolean = true

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

canUpload

get canUpload(): boolean

- Defined in src/interactioncommandclient.ts:188
Returns boolean

manager

get manager(): null | ClusterProcessChild

- Defined in src/interactioncommandclient.ts:196
Returns null | ClusterProcessChild

rest

get rest(): RestClient | Client

- Defined in src/interactioncommandclient.ts:200
Returns RestClient | Client

Methods

add

add(options: InteractionCommand<ParsedArgs> | InteractionCommandClientAddOptions, run?: CommandCallbackRun): InteractionCommandClient

- Defined in src/interactioncommandclient.ts:205
Parameters
- options: InteractionCommand<ParsedArgs> | InteractionCommandClientAddOptions
- Optional run: CommandCallbackRun
Returns InteractionCommandClient

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient

Inherited from EventSpewer.addListener
- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient

addMultiple

addMultiple(commands?: (InteractionCommand<ParsedArgs> | InteractionCommandOptions)[]): InteractionCommandClient

- Defined in src/interactioncommandclient.ts:260
Parameters
- commands: (InteractionCommand<ParsedArgs> | InteractionCommandOptions)[] = []
Returns InteractionCommandClient

addMultipleIn

addMultipleIn(directory: string, options?: { isAbsolute?: boolean; subdirectories?: boolean }): Promise<InteractionCommandClient>

- Defined in src/interactioncommandclient.ts:267
Parameters
- directory: string
- options: { isAbsolute?: boolean; subdirectories?: boolean } = {}
  - Optional isAbsolute?: boolean
  - Optional subdirectories?: boolean
Returns Promise<InteractionCommandClient>

checkAndUploadCommands

checkAndUploadCommands(force?: boolean): Promise<void>

- Defined in src/interactioncommandclient.ts:371
Parameters
- force: boolean = false
Returns Promise<void>

checkApplicationCommands

checkApplicationCommands(guildId?: string): Promise<boolean>

- Defined in src/interactioncommandclient.ts:363
Parameters
- Optional guildId: string
Returns Promise<boolean>

clear

clear(): void

- Defined in src/interactioncommandclient.ts:327
Returns void

clearSubscriptions

clearSubscriptions(): void

- Defined in src/interactioncommandclient.ts:345
Returns void

createApplicationCommandsFromRaw

createApplicationCommandsFromRaw(data: any[]): BaseCollection<string, ApplicationCommand>

- Defined in src/interactioncommandclient.ts:387
Parameters
- data: any[]
Returns BaseCollection<string, ApplicationCommand>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventSpewer.emit
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventSpewer.eventNames
- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

fetchApplicationCommands

fetchApplicationCommands(guildId?: string): Promise<BaseCollection<string, ApplicationCommand>>

- Defined in src/interactioncommandclient.ts:398
Parameters
- Optional guildId: string
Returns Promise<BaseCollection<string, ApplicationCommand>>

getMaxListeners

getMaxListeners(): number

Inherited from EventSpewer.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64
Returns number

handle

handle(name: INTERACTION_CREATE, event: InteractionCreate): Promise<void>

- Defined in src/interactioncommandclient.ts:703
Parameters
- name: INTERACTION_CREATE
- event: InteractionCreate
Returns Promise<void>

handleInteractionCreate

handleInteractionCreate(event: InteractionCreate): Promise<void>

- Defined in src/interactioncommandclient.ts:699
Parameters
- event: InteractionCreate
Returns Promise<void>

hasEventListener

hasEventListener(name: string | symbol): boolean

Inherited from EventSpewer.hasEventListener
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:16
Parameters
- name: string | symbol
Returns boolean

kill

kill(): void

- Defined in src/interactioncommandclient.ts:673
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventSpewer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventSpewer.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient

Inherited from EventSpewer.off
- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient

on

on(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient
on(event: COMMAND_ERROR, listener: (payload: CommandError) => any): InteractionCommandClient
on(event: "commandError", listener: (payload: CommandError) => any): InteractionCommandClient
on(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): InteractionCommandClient
on(event: "commandFail", listener: (payload: CommandFail) => any): InteractionCommandClient
on(event: COMMAND_PERMISSIONS_FAIL_CLIENT, listener: (payload: CommandPermissionsFailClient) => any): InteractionCommandClient
on(event: "commandPermissionsFailClient", listener: (payload: CommandPermissionsFailClient) => any): InteractionCommandClient
on(event: COMMAND_PERMISSIONS_FAIL, listener: (payload: CommandPermissionsFail) => any): InteractionCommandClient
on(event: "commandPermissionsFail", listener: (payload: CommandPermissionsFail) => any): InteractionCommandClient
on(event: COMMAND_RAN, listener: (payload: CommandRan) => any): InteractionCommandClient
on(event: "commandRan", listener: (payload: CommandRan) => any): InteractionCommandClient
on(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): InteractionCommandClient
on(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): InteractionCommandClient
on(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): InteractionCommandClient
on(event: "commandRunError", listener: (payload: CommandRunError) => any): InteractionCommandClient
on(event: KILLED, listener: () => any): InteractionCommandClient

Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1014
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1015
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1016
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1017
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1018
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1019
Parameters
- event: COMMAND_PERMISSIONS_FAIL_CLIENT
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1020
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1021
Parameters
- event: COMMAND_PERMISSIONS_FAIL
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1022
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1023
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1024
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1025
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1026
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1027
Parameters
- event: COMMAND_RUN_ERROR
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1028
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.on
- Defined in src/interactioncommandclient.ts:1029
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns InteractionCommandClient

Optional onCommandCancel

onCommandCancel(context: InteractionContext, command: InteractionCommand<ParsedArgs>): any

- Defined in src/interactioncommandclient.ts:105
Parameters
- context: InteractionContext
- command: InteractionCommand<ParsedArgs>
Returns any

Optional onCommandCheck

onCommandCheck(context: InteractionContext, command: InteractionCommand<ParsedArgs>): boolean | Promise<boolean>

- Defined in src/interactioncommandclient.ts:104
Parameters
- context: InteractionContext
- command: InteractionCommand<ParsedArgs>
Returns boolean | Promise<boolean>

Optional onInteractionCancel

onInteractionCancel(context: InteractionContext): any

- Defined in src/interactioncommandclient.ts:107
Parameters
- context: InteractionContext
Returns any

Optional onInteractionCheck

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

- Defined in src/interactioncommandclient.ts:106
Parameters
- context: InteractionContext
Returns boolean | Promise<boolean>

once

once(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient
once(event: COMMAND_ERROR, listener: (payload: CommandError) => any): InteractionCommandClient
once(event: "commandError", listener: (payload: CommandError) => any): InteractionCommandClient
once(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): InteractionCommandClient
once(event: "commandFail", listener: (payload: CommandFail) => any): InteractionCommandClient
once(event: COMMAND_PERMISSIONS_FAIL_CLIENT, listener: (payload: CommandPermissionsFailClient) => any): InteractionCommandClient
once(event: "commandPermissionsFailClient", listener: (payload: CommandPermissionsFailClient) => any): InteractionCommandClient
once(event: COMMAND_PERMISSIONS_FAIL, listener: (payload: CommandPermissionsFail) => any): InteractionCommandClient
once(event: "commandPermissionsFail", listener: (payload: CommandPermissionsFail) => any): InteractionCommandClient
once(event: COMMAND_RAN, listener: (payload: CommandRan) => any): InteractionCommandClient
once(event: "commandRan", listener: (payload: CommandRan) => any): InteractionCommandClient
once(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): InteractionCommandClient
once(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): InteractionCommandClient
once(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): InteractionCommandClient
once(event: "commandRunError", listener: (payload: CommandRunError) => any): InteractionCommandClient
once(event: KILLED, listener: () => any): InteractionCommandClient

Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1035
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1036
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1037
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1038
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1039
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1040
Parameters
- event: COMMAND_PERMISSIONS_FAIL_CLIENT
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1041
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1042
Parameters
- event: COMMAND_PERMISSIONS_FAIL
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1043
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1044
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1045
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1046
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1047
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1048
Parameters
- event: COMMAND_RUN_ERROR
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1049
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns InteractionCommandClient
Overrides EventSpewer.once
- Defined in src/interactioncommandclient.ts:1050
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns InteractionCommandClient

parseArgs

parseArgs(context: InteractionContext, data: InteractionDataApplicationCommand): Promise<[ParsedArgs, null | ParsedErrors]>

- Defined in src/interactioncommandclient.ts:471
Parameters
- context: InteractionContext
- data: InteractionDataApplicationCommand
Returns Promise<[ParsedArgs, null | ParsedErrors]>

parseArgsFromContextMenu

parseArgsFromContextMenu(data: InteractionDataApplicationCommand): Promise<[ParsedArgs, null]>

- Defined in src/interactioncommandclient.ts:480
Parameters
- data: InteractionDataApplicationCommand
Returns Promise<[ParsedArgs, null]>

parseArgsFromOptions

parseArgsFromOptions(context: InteractionContext, commandOptions?: BaseCollection<string, InteractionCommandOption<ParsedArgs>>, options?: BaseCollection<string, InteractionDataApplicationCommandOption>, resolved?: InteractionDataApplicationCommandResolved): Promise<[ParsedArgs, null | ParsedErrors]>

- Defined in src/interactioncommandclient.ts:502
Parameters
- context: InteractionContext
- Optional commandOptions: BaseCollection<string, InteractionCommandOption<ParsedArgs>>
- Optional options: BaseCollection<string, InteractionDataApplicationCommandOption>
- Optional resolved: InteractionDataApplicationCommandResolved
Returns Promise<[ParsedArgs, null | ParsedErrors]>

parseDefaultArgsFromOptions

parseDefaultArgsFromOptions(context: InteractionContext, commandOptions: BaseCollection<string, InteractionCommandOption<ParsedArgs>>, args?: ParsedArgs, errors?: ParsedErrors): Promise<boolean>

- Defined in src/interactioncommandclient.ts:636
Parameters
- context: InteractionContext
- commandOptions: BaseCollection<string, InteractionCommandOption<ParsedArgs>>
- args: ParsedArgs = {}
- errors: ParsedErrors = {}
Returns Promise<boolean>

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient

Inherited from EventSpewer.prependListener
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient

Inherited from EventSpewer.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventSpewer.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(name?: string | symbol): InteractionCommandClient

Inherited from EventSpewer.removeAllListeners
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:19
Parameters
- Optional name: string | symbol
Returns InteractionCommandClient

removeAllSubscriptions

removeAllSubscriptions(): InteractionCommandClient

Inherited from EventSpewer.removeAllSubscriptions
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:20
Returns InteractionCommandClient

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): InteractionCommandClient

Inherited from EventSpewer.removeListener
- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns InteractionCommandClient

removeSubscription

removeSubscription(subscription: EventSubscription): void

Inherited from EventSpewer.removeSubscription
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:18
Parameters
- subscription: EventSubscription
Returns void

resetCommands

resetCommands(): Promise<void>

- Defined in src/interactioncommandclient.ts:354
Returns Promise<void>

run

run(options?: InteractionCommandClientRunOptions): Promise<ClusterClient | ShardClient>

- Defined in src/interactioncommandclient.ts:680
Parameters
- options: InteractionCommandClientRunOptions = {}
Returns Promise<ClusterClient | ShardClient>

setMaxListeners

setMaxListeners(n: number): InteractionCommandClient

Inherited from EventSpewer.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns InteractionCommandClient

setSubscriptions

setSubscriptions(): void

- Defined in src/interactioncommandclient.ts:665
Returns void

subscribe(event: string | symbol, listener: (...args: any[]) => void): EventSubscription
subscribe(event: COMMAND_ERROR, listener: (payload: CommandError) => any): EventSubscription
subscribe(event: "commandError", listener: (payload: CommandError) => any): EventSubscription
subscribe(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): EventSubscription
subscribe(event: "commandFail", listener: (payload: CommandFail) => any): EventSubscription
subscribe(event: COMMAND_PERMISSIONS_FAIL_CLIENT, listener: (payload: CommandPermissionsFailClient) => any): EventSubscription
subscribe(event: "commandPermissionsFailClient", listener: (payload: CommandPermissionsFailClient) => any): EventSubscription
subscribe(event: COMMAND_PERMISSIONS_FAIL, listener: (payload: CommandPermissionsFail) => any): EventSubscription
subscribe(event: "commandPermissionsFail", listener: (payload: CommandPermissionsFail) => any): EventSubscription
subscribe(event: COMMAND_RAN, listener: (payload: CommandRan) => any): EventSubscription
subscribe(event: "commandRan", listener: (payload: CommandRan) => any): EventSubscription
subscribe(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): EventSubscription
subscribe(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): EventSubscription
subscribe(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): EventSubscription
subscribe(event: "commandRunError", listener: (payload: CommandRunError) => any): EventSubscription
subscribe(event: KILLED, listener: () => any): EventSubscription
subscribe(event: "killed", listener: () => any): EventSubscription

Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1056
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1057
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1058
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1059
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1060
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1061
Parameters
- event: COMMAND_PERMISSIONS_FAIL_CLIENT
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1062
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1063
Parameters
- event: COMMAND_PERMISSIONS_FAIL
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1064
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1065
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1066
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1067
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1068
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1069
Parameters
- event: COMMAND_RUN_ERROR
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1070
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1071
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/interactioncommandclient.ts:1072
Parameters
- event: "killed"
- listener: () => any
  - - (): any
    - Returns any
Returns EventSubscription

uploadApplicationCommands

uploadApplicationCommands(guildId?: string): Promise<BaseCollection<string, ApplicationCommand>>

- Defined in src/interactioncommandclient.ts:420
Parameters
- Optional guildId: string
Returns Promise<BaseCollection<string, ApplicationCommand>>

validateCommands

validateCommands(commands: BaseCollection<string, ApplicationCommand>): boolean

- Defined in src/interactioncommandclient.ts:440
Parameters
- commands: BaseCollection<string, ApplicationCommand>
Returns boolean

validateCommandsFromRaw

validateCommandsFromRaw(data: any[]): boolean

- Defined in src/interactioncommandclient.ts:465
Parameters
- data: any[]
Returns boolean

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventSpewer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventSpewer.on
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from EventSpewer.once
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventSpewer.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

token: string | ClusterClient | CommandClient | ShardClient

options: InteractionCommandClientOptions = {}

Returns InteractionCommandClient

Properties

Readonly _clientSubscriptions

checkCommands

client

commands

commandsById

directories

ran

ratelimiter

ratelimits

strictCommandCheck

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

canUpload

Returns boolean

manager

Returns null | ClusterProcessChild

rest

Returns RestClient | Client

Methods

add

Parameters

options: InteractionCommand<ParsedArgs> | InteractionCommandClientAddOptions

Optional run: CommandCallbackRun

Returns InteractionCommandClient

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns InteractionCommandClient

addMultiple

Parameters

commands: (InteractionCommand<ParsedArgs> | InteractionCommandOptions)[] = []

Returns InteractionCommandClient

addMultipleIn

Parameters

directory: string

options: { isAbsolute?: boolean; subdirectories?: boolean } = {}

Optional isAbsolute?: boolean

Optional subdirectories?: boolean

Returns Promise<InteractionCommandClient>

checkAndUploadCommands

Parameters

force: boolean = false

Returns Promise<void>

checkApplicationCommands

Parameters

Optional guildId: string

Returns Promise<boolean>

clear

Returns void

clearSubscriptions

Returns void

createApplicationCommandsFromRaw

Parameters

data: any[]

Returns BaseCollection<string, ApplicationCommand>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean