CommandClient | Detritus Client

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

Hierarchy

EventSpewer
- CommandClient

Implements

EventEmitter

Index

Constructors

constructor

Properties

Accessors

rest

Methods

Constructors

constructor

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

Overrides EventSpewer.__constructor
- Defined in src/commandclient.ts:98
Parameters
- token: ShardClient | string
- Default value options: CommandClientOptions = {}
Returns CommandClient

Properties

_clientSubscriptions

_clientSubscriptions: Array<EventSubscription> = []

activateOnEdits

activateOnEdits: boolean = false

client

client: ClusterClient | ShardClient

commands

commands: Array<Command>

ignoreMe

ignoreMe: boolean = true

maxEditDuration

maxEditDuration: number = 5 * 60 * 1000

mentionsEnabled

mentionsEnabled: boolean = true

prefixes

prefixes: object

Type declaration

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

ran

ran: boolean

ratelimits

ratelimits: Array<CommandRatelimit> = []

replies

replies: BaseCollection<string, CommandReply>

Accessors

rest

get rest(): RestClient | Client

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

Methods

add

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

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

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addMentionPrefixes

addMentionPrefixes(): void

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

addMultiple

addMultiple(commands?: Array<CommandOptions>): CommandClient

- Defined in src/commandclient.ts:260
Parameters
- Default value commands: Array<CommandOptions> = []
Returns CommandClient

addMultipleIn

addMultipleIn(directory: string, options?: object): Promise<CommandClient>

- Defined in src/commandclient.ts:267
Parameters
- directory: string
- Default value options: object = {}
  - Optional isAbsolute?: undefined | false | true
  - Optional subdirectories?: undefined | false | true
Returns Promise<CommandClient>

clear

clear(): void

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

emit

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

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

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:568
Returns Array<string | symbol>

getAttributes

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

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

getCommand

getCommand(attributes: CommandAttributes): Command | null

- Defined in src/commandclient.ts:390
Parameters
- attributes: CommandAttributes
Returns Command | null

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:560
Returns number

getPrefixes

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

- Defined in src/commandclient.ts:404
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:482
Parameters
- name: MESSAGE_CREATE
- event: MessageCreate
Returns Promise<void>
- Defined in src/commandclient.ts:483
Parameters
- name: MESSAGE_UPDATE
- event: MessageUpdate
Returns Promise<void>

handleDelete

handleDelete(name: string, deletePayload: object): Promise<void>

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

handleMessageCreate

handleMessageCreate(event: MessageCreate): Promise<void>

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

handleMessageUpdate

handleMessageUpdate(event: MessageUpdate): Promise<void>

- Defined in src/commandclient.ts:475
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:445
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:564
Parameters
- type: string | symbol
Returns number

listeners

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

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

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this
on(event: "commandDelete", listener: function): this
on(event: "commandError", listener: function): this
on(event: "commandFail", listener: function): this
on(event: "commandNone", listener: function): this
on(event: "commandPermissionsFailClient", listener: function): this
on(event: "commandPermissionsFail", listener: function): this
on(event: "commandRan", listener: function): this
on(event: "commandRatelimit", listener: function): this
on(event: "commandResponseDelete", listener: function): this
on(event: "commandRunError", listener: function): this
on(event: "killed", listener: function): this

Overrides EventEmitter.on
- Defined in src/commandclient.ts:831
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:832
Parameters
- event: "commandDelete"
- listener: function
  - - (payload: CommandDelete): any
    - Parameters
      - payload: CommandDelete
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:833
Parameters
- event: "commandError"
- listener: function
  - - (payload: CommandError): any
    - Parameters
      - payload: CommandError
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:834
Parameters
- event: "commandFail"
- listener: function
  - - (payload: CommandFail): any
    - Parameters
      - payload: CommandFail
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:835
Parameters
- event: "commandNone"
- listener: function
  - - (payload: CommandNone): any
    - Parameters
      - payload: CommandNone
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:836
Parameters
- event: "commandPermissionsFailClient"
- listener: function
  - - (payload: CommandPermissionsFailClient): any
    - Parameters
      - payload: CommandPermissionsFailClient
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:837
Parameters
- event: "commandPermissionsFail"
- listener: function
  - - (payload: CommandPermissionsFail): any
    - Parameters
      - payload: CommandPermissionsFail
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:838
Parameters
- event: "commandRan"
- listener: function
  - - (payload: CommandRan): any
    - Parameters
      - payload: CommandRan
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:839
Parameters
- event: "commandRatelimit"
- listener: function
  - - (payload: CommandRatelimit): any
    - Parameters
      - payload: CommandRatelimit
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:840
Parameters
- event: "commandResponseDelete"
- listener: function
  - - (payload: CommandResponseDelete): any
    - Parameters
      - payload: CommandResponseDelete
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:841
Parameters
- event: "commandRunError"
- listener: function
  - - (payload: CommandRunError): any
    - Parameters
      - payload: CommandRunError
      Returns any
Returns this
Overrides EventEmitter.on
- Defined in src/commandclient.ts:842
Parameters
- event: "killed"
- listener: function
  - - (): any
    - Returns any
Returns this

Optional onCommandCheck

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

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

Optional onMessageCheck

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

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

Optional onPrefixCheck

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

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

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/globals.d.ts:566
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:567
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(name?: string | symbol): this

Inherited from EventSpewer.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:19
Parameters
- Optional name: string | symbol
Returns this

removeAllSubscriptions

removeAllSubscriptions(): this

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

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

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

resetSubscriptions

resetSubscriptions(): void

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

run

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

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

setActivateOnEdits

setActivateOnEdits(value: boolean): void

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

setMaxEditDuration

setMaxEditDuration(value: number): void

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:559
Parameters
- n: number
Returns this

setMentionsEnabled

setMentionsEnabled(value: boolean): void

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

setPrefixSpace

setPrefixSpace(value: boolean): void

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

setSubscriptions

setSubscriptions(): void

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

storeReply

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

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

subscribe(name: string | symbol, listener: function): EventSubscription

Inherited from EventSpewer.subscribe
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:17
Parameters
- name: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns EventSubscription

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

token: ShardClient | string

Default value options: CommandClientOptions = {}

Returns CommandClient

Properties

_clientSubscriptions

activateOnEdits

client

commands

ignoreMe

maxEditDuration

mentionsEnabled

prefixes

Type declaration

custom: BaseSet<string>

mention: BaseSet<string>

ran

ratelimits

replies

Accessors

rest

Returns RestClient | Client

Methods

add

Parameters

options: Command | CommandClientAdd | string

Optional run: CommandCallbackRun

Returns CommandClient

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

addMentionPrefixes

Returns void

addMultiple

Parameters

Default value commands: Array<CommandOptions> = []

Returns CommandClient

addMultipleIn

Parameters

directory: string

Default value options: object = {}

Optional isAbsolute?: undefined | false | true

Optional subdirectories?: undefined | false | true

Returns Promise<CommandClient>

clear

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getAttributes

Parameters

context: Context

Returns Promise<CommandAttributes | null>

getCommand

Parameters

attributes: CommandAttributes

Returns Command | null

getMaxListeners

Returns number

getPrefixes

Parameters

context: Context