CommandClient | Detritus Client

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

Hierarchy

EventSpewer
- CommandClient

Index

Constructors

constructor

Properties

Accessors

rest

Methods

Constructors

constructor

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

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

Properties

Readonly _clientSubscriptions

_clientSubscriptions: EventSubscription[] = []

activateOnEdits

activateOnEdits: boolean = false

client

client: ClusterClient | ShardClient

commands

commands: Command<any>[]

directories

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

ignoreMe

ignoreMe: boolean = true

maxEditDuration

maxEditDuration: number = ...

mentionsEnabled

mentionsEnabled: boolean = true

prefixes

prefixes: { custom: BaseSet<string>; mention: BaseSet<string> }

Type declaration

custom: BaseSet<string>
mention: BaseSet<string>

ran

ran: boolean = false

ratelimiter

ratelimiter: CommandRatelimiter

ratelimits

ratelimits: CommandRatelimit[] = []

replies

replies: BaseCollection<string, CommandReply>

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

rest

get rest(): RestClient | Client

- Defined in src/commandclient.ts:233
Returns RestClient | Client

Methods

add

add(options: string | Command<any> | CommandClientAdd, run?: CommandCallbackRun): CommandClient

- Defined in src/commandclient.ts:255
Parameters
- options: string | Command<any> | CommandClientAdd
- Optional run: CommandCallbackRun
Returns CommandClient

addListener

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

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 CommandClient

addMentionPrefixes

addMentionPrefixes(): void

- Defined in src/commandclient.ts:402
Returns void

addMultiple

addMultiple(commands?: CommandOptions[]): CommandClient

- Defined in src/commandclient.ts:305
Parameters
- commands: CommandOptions[] = []
Returns CommandClient

addMultipleIn

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

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

clear

clear(): void

- Defined in src/commandclient.ts:372
Returns void

clearSubscriptions

clearSubscriptions(): void

- Defined in src/commandclient.ts:385
Returns void

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)[]

getAttributes

getAttributes(context: Context): Promise<null | CommandAttributes>

- Defined in src/commandclient.ts:423
Parameters
- context: Context
Returns Promise<null | CommandAttributes>

getCommand

getCommand(attributes: CommandAttributes): null | Command<any>

- Defined in src/commandclient.ts:458
Parameters
- attributes: CommandAttributes
Returns null | Command<any>

getMaxListeners

getMaxListeners(): number

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

getPrefixes

getPrefixes(context: Context): Promise<BaseSet<string>>

- Defined in src/commandclient.ts:472
Parameters
- context: Context
Returns Promise<BaseSet<string>>

handle

handle(name: MESSAGE_CREATE, event: MessageCreate): Promise<void>
handle(name: MESSAGE_UPDATE, event: MessageUpdate): Promise<void>

- Defined in src/commandclient.ts:546
Parameters
- name: MESSAGE_CREATE
- event: MessageCreate
Returns Promise<void>
- Defined in src/commandclient.ts:547
Parameters
- name: MESSAGE_UPDATE
- event: MessageUpdate
Returns Promise<void>

handleDelete

handleDelete(name: string, deletePayload: { raw: { id: string } }): Promise<void>

- Defined in src/commandclient.ts:896
Parameters
- name: string
- deletePayload: { raw: { id: string } }
  - raw: { id: string }
    - id: string
Returns Promise<void>

handleMessageCreate

handleMessageCreate(event: MessageCreate): Promise<void>

- Defined in src/commandclient.ts:535
Parameters
- event: MessageCreate
Returns Promise<void>

handleMessageUpdate

handleMessageUpdate(event: MessageUpdate): Promise<void>

- Defined in src/commandclient.ts:539
Parameters
- event: MessageUpdate
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/commandclient.ts:504
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): CommandClient

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 CommandClient

on

on(event: string | symbol, listener: (...args: any[]) => void): CommandClient
on(event: COMMAND_DELETE, listener: (payload: CommandDelete) => any): CommandClient
on(event: "commandDelete", listener: (payload: CommandDelete) => any): CommandClient
on(event: COMMAND_ERROR, listener: (payload: CommandError) => any): CommandClient
on(event: "commandError", listener: (payload: CommandError) => any): CommandClient
on(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): CommandClient
on(event: "commandFail", listener: (payload: CommandFail) => any): CommandClient
on(event: COMMAND_NONE, listener: (payload: CommandNone) => any): CommandClient
on(event: "commandNone", listener: (payload: CommandNone) => any): CommandClient
on(event: COMMAND_PERMISSIONS_FAIL_CLIENT, listener: (payload: CommandPermissionsFailClient) => any): CommandClient
on(event: "commandPermissionsFailClient", listener: (payload: CommandPermissionsFailClient) => any): CommandClient
on(event: COMMAND_PERMISSIONS_FAIL, listener: (payload: CommandPermissionsFail) => any): CommandClient
on(event: "commandPermissionsFail", listener: (payload: CommandPermissionsFail) => any): CommandClient
on(event: COMMAND_RAN, listener: (payload: CommandRan) => any): CommandClient
on(event: "commandRan", listener: (payload: CommandRan) => any): CommandClient
on(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): CommandClient
on(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): CommandClient
on(event: COMMAND_RESPONSE_DELETE, listener: (payload: CommandResponseDelete) => any): CommandClient
on(event: "commandResponseDelete", listener: (payload: CommandResponseDelete) => any): CommandClient
on(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): CommandClient
on(event: "commandRunError", listener: (payload: CommandRunError) => any): CommandClient
on(event: KILLED, listener: () => any): CommandClient
on(event: "killed", listener: () => any): CommandClient

Overrides EventSpewer.on
- Defined in src/commandclient.ts:916
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:917
Parameters
- event: COMMAND_DELETE
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:918
Parameters
- event: "commandDelete"
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:919
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:920
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:921
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:922
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:923
Parameters
- event: COMMAND_NONE
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:924
Parameters
- event: "commandNone"
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:925
Parameters
- event: COMMAND_PERMISSIONS_FAIL_CLIENT
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:926
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:927
Parameters
- event: COMMAND_PERMISSIONS_FAIL
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:928
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:929
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:930
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:931
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:932
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:933
Parameters
- event: COMMAND_RESPONSE_DELETE
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:934
Parameters
- event: "commandResponseDelete"
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:935
Parameters
- event: COMMAND_RUN_ERROR
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:936
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:937
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns CommandClient
Overrides EventSpewer.on
- Defined in src/commandclient.ts:938
Parameters
- event: "killed"
- listener: () => any
  - - (): any
    - Returns any
Returns CommandClient

Optional onCommandCancel

onCommandCancel(context: Context, command: Command<any>): any

- Defined in src/commandclient.ts:107
Parameters
- context: Context
- command: Command<any>
Returns any

Optional onCommandCheck

onCommandCheck(context: Context, command: Command<any>): boolean | Promise<boolean>

- Defined in src/commandclient.ts:106
Parameters
- context: Context
- command: Command<any>
Returns boolean | Promise<boolean>

Optional onMessageCancel

onMessageCancel(context: Context): any

- Defined in src/commandclient.ts:109
Parameters
- context: Context
Returns any

Optional onMessageCheck

onMessageCheck(context: Context): boolean | Promise<boolean>

- Defined in src/commandclient.ts:108
Parameters
- context: Context
Returns boolean | Promise<boolean>

Optional onPrefixCheck

onPrefixCheck(context: Context): CommandClientPrefixes | Promise<CommandClientPrefixes>

- Defined in src/commandclient.ts:110
Parameters
- context: Context
Returns CommandClientPrefixes | Promise<CommandClientPrefixes>

once

once(event: string | symbol, listener: (...args: any[]) => void): CommandClient
once(event: COMMAND_DELETE, listener: (payload: CommandDelete) => any): CommandClient
once(event: "commandDelete", listener: (payload: CommandDelete) => any): CommandClient
once(event: COMMAND_ERROR, listener: (payload: CommandError) => any): CommandClient
once(event: "commandError", listener: (payload: CommandError) => any): CommandClient
once(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): CommandClient
once(event: "commandFail", listener: (payload: CommandFail) => any): CommandClient
once(event: COMMAND_NONE, listener: (payload: CommandNone) => any): CommandClient
once(event: "commandNone", listener: (payload: CommandNone) => any): CommandClient
once(event: COMMAND_PERMISSIONS_FAIL_CLIENT, listener: (payload: CommandPermissionsFailClient) => any): CommandClient
once(event: "commandPermissionsFailClient", listener: (payload: CommandPermissionsFailClient) => any): CommandClient
once(event: COMMAND_PERMISSIONS_FAIL, listener: (payload: CommandPermissionsFail) => any): CommandClient
once(event: "commandPermissionsFail", listener: (payload: CommandPermissionsFail) => any): CommandClient
once(event: COMMAND_RAN, listener: (payload: CommandRan) => any): CommandClient
once(event: "commandRan", listener: (payload: CommandRan) => any): CommandClient
once(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): CommandClient
once(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): CommandClient
once(event: COMMAND_RESPONSE_DELETE, listener: (payload: CommandResponseDelete) => any): CommandClient
once(event: "commandResponseDelete", listener: (payload: CommandResponseDelete) => any): CommandClient
once(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): CommandClient
once(event: "commandRunError", listener: (payload: CommandRunError) => any): CommandClient
once(event: KILLED, listener: () => any): CommandClient
once(event: "killed", listener: () => any): CommandClient

Overrides EventSpewer.once
- Defined in src/commandclient.ts:944
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:945
Parameters
- event: COMMAND_DELETE
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:946
Parameters
- event: "commandDelete"
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:947
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:948
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:949
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:950
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:951
Parameters
- event: COMMAND_NONE
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:952
Parameters
- event: "commandNone"
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:953
Parameters
- event: COMMAND_PERMISSIONS_FAIL_CLIENT
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:954
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:955
Parameters
- event: COMMAND_PERMISSIONS_FAIL
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:956
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:957
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:958
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:959
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:960
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:961
Parameters
- event: COMMAND_RESPONSE_DELETE
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:962
Parameters
- event: "commandResponseDelete"
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:963
Parameters
- event: COMMAND_RUN_ERROR
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:964
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:965
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns CommandClient
Overrides EventSpewer.once
- Defined in src/commandclient.ts:966
Parameters
- event: "killed"
- listener: () => any
  - - (): any
    - Returns any
Returns CommandClient

prependListener

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

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 CommandClient

prependOnceListener

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

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 CommandClient

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): CommandClient

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

removeAllSubscriptions

removeAllSubscriptions(): CommandClient

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

removeListener

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

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 CommandClient

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/commandclient.ts:394
Returns Promise<void>

run

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

- Defined in src/commandclient.ts:511
Parameters
- options: CommandClientRunOptions = {}
Returns Promise<ClusterClient | ShardClient>

setActivateOnEdits

setActivateOnEdits(value: boolean): void

- Defined in src/commandclient.ts:238
Parameters
- value: boolean
Returns void

setMaxEditDuration

setMaxEditDuration(value: number): void

- Defined in src/commandclient.ts:242
Parameters
- value: number
Returns void

setMaxListeners

setMaxListeners(n: number): CommandClient

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

setMentionsEnabled

setMentionsEnabled(value: boolean): void

- Defined in src/commandclient.ts:246
Parameters
- value: boolean
Returns void

setPrefixSpace

setPrefixSpace(value: boolean): void

- Defined in src/commandclient.ts:250
Parameters
- value: boolean
Returns void

setSubscriptions

setSubscriptions(): void

- Defined in src/commandclient.ts:494
Returns void

storeReply

storeReply(messageId: string, command: Command<any>, context: Context, reply: Message): void

- Defined in src/commandclient.ts:528
Parameters
- messageId: string
- command: Command<any>
- context: Context
- reply: Message
Returns void

subscribe(event: string | symbol, listener: (...args: any[]) => void): EventSubscription
subscribe(event: COMMAND_DELETE, listener: (payload: CommandDelete) => any): EventSubscription
subscribe(event: "commandDelete", listener: (payload: CommandDelete) => any): 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_NONE, listener: (payload: CommandNone) => any): EventSubscription
subscribe(event: "commandNone", listener: (payload: CommandNone) => 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_RESPONSE_DELETE, listener: (payload: CommandResponseDelete) => any): EventSubscription
subscribe(event: "commandResponseDelete", listener: (payload: CommandResponseDelete) => 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/commandclient.ts:972
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/commandclient.ts:973
Parameters
- event: COMMAND_DELETE
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:974
Parameters
- event: "commandDelete"
- listener: (payload: CommandDelete) => any
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:975
Parameters
- event: COMMAND_ERROR
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:976
Parameters
- event: "commandError"
- listener: (payload: CommandError) => any
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:977
Parameters
- event: COMMAND_FAIL
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:978
Parameters
- event: "commandFail"
- listener: (payload: CommandFail) => any
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:979
Parameters
- event: COMMAND_NONE
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:980
Parameters
- event: "commandNone"
- listener: (payload: CommandNone) => any
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:981
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/commandclient.ts:982
Parameters
- event: "commandPermissionsFailClient"
- listener: (payload: CommandPermissionsFailClient) => any
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:983
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/commandclient.ts:984
Parameters
- event: "commandPermissionsFail"
- listener: (payload: CommandPermissionsFail) => any
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:985
Parameters
- event: COMMAND_RAN
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:986
Parameters
- event: "commandRan"
- listener: (payload: CommandRan) => any
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:987
Parameters
- event: COMMAND_RATELIMIT
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:988
Parameters
- event: "commandRatelimit"
- listener: (payload: CommandRatelimit) => any
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:989
Parameters
- event: COMMAND_RESPONSE_DELETE
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:990
Parameters
- event: "commandResponseDelete"
- listener: (payload: CommandResponseDelete) => any
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:991
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/commandclient.ts:992
Parameters
- event: "commandRunError"
- listener: (payload: CommandRunError) => any
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:993
Parameters
- event: KILLED
- listener: () => any
  - - (): any
    - Returns any
Returns EventSubscription
Overrides EventSpewer.subscribe
- Defined in src/commandclient.ts:994
Parameters
- event: "killed"
- listener: () => any
  - - (): any
    - Returns any
Returns EventSubscription

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 | InteractionCommandClient | ShardClient

options: CommandClientOptions = {}

Returns CommandClient

Properties

Readonly _clientSubscriptions

activateOnEdits

client

commands

directories

ignoreMe

maxEditDuration

mentionsEnabled

prefixes

Type declaration

custom: BaseSet<string>

mention: BaseSet<string>

ran

ratelimiter

ratelimits

replies

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

rest

Returns RestClient | Client

Methods

add

Parameters

options: string | Command<any> | CommandClientAdd

Optional run: CommandCallbackRun

Returns CommandClient

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns CommandClient

addMentionPrefixes

Returns void

addMultiple

Parameters

commands: CommandOptions[] = []

Returns CommandClient

addMultipleIn

Parameters

directory: string

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

Optional isAbsolute?: boolean

Optional subdirectories?: boolean

Returns Promise<CommandClient>

clear

Returns void

clearSubscriptions

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getAttributes

Parameters

context: Context

Returns Promise<null | CommandAttributes>

getCommand

Parameters