CommandClientclass

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

On this page

Overview
Constructor1
Properties14
Accessors1
Methods34

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

import { CommandClient } from 'detritus-client';

Hierarchy

EventEmitterEventSpewerCommandClient

14 properties34 methodssrc/commandclient.ts:103

Constructor

new CommandClient

src/commandclient.ts:129

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

Properties

_clientSubscriptions

EventSubscription[]

readonly

Default []

activateOnEdits

boolean

Default false

client

ClusterClient | ShardClient

commands

Command<any>[]

directories

BaseCollection<string, { subdirectories: boolean }>

ignoreMe

boolean

Default true

maxEditDuration

number

mentionsEnabled

boolean

Default true

prefixes

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

prefixSpace

boolean

Default false

ran

boolean

Default false

ratelimiter

CommandRatelimiter

ratelimits

CommandRatelimit[]

Default []

replies

BaseCollection<string, CommandReply>

Accessors

rest

RestClient | Client

get

Methods

add()

src/commandclient.ts:278

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

addMentionPrefixes()

src/commandclient.ts:425

addMentionPrefixes(): void

addMultiple()

src/commandclient.ts:328

addMultiple(commands?: CommandOptions[]): CommandClient

Parameters

commands?

CommandOptions[]

Default []

addMultipleIn()

async src/commandclient.ts:335

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

Parameters

clear()

src/commandclient.ts:395

clear(): void

clearSubscriptions()

src/commandclient.ts:408

clearSubscriptions(): void

getAttributes()

async src/commandclient.ts:446

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

getCommand()

async src/commandclient.ts:488

getCommand(attributes: CommandAttributes, context?: Context): Promise<Command<any> | null>

getPrefixes()

async src/commandclient.ts:502

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

handle()

async src/commandclient.ts:600

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

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

handleContext()

async src/commandclient.ts:647

handleContext(
  name: MESSAGE_CREATE | MESSAGE_UPDATE,
  event: MessageCreate | MessageUpdate,
  context: Context,
): Promise<void>

handleDelete()

async src/commandclient.ts:1022

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

Parameters

name

MESSAGE_DELETE

deletePayload

{ raw: { id: string } }

deletePayload.raw

{ id: string }

handleDeleteBulk()

async src/commandclient.ts:1043

handleDeleteBulk(deletePayload: { raw: { ids: string[] } }): Promise<void>

Parameters

deletePayload

{ raw: { ids: string[] } }

deletePayload.raw

{ ids: string[] }

handleMessageCreate()

async src/commandclient.ts:569

handleMessageCreate(event: MessageCreate): Promise<void>

handleMessageUpdate()

async src/commandclient.ts:593

handleMessageUpdate(event: MessageUpdate): Promise<void>

isContentEdit()

src/commandclient.ts:576

isContentEdit(event: MessageUpdate): boolean

If a MESSAGE_UPDATE changed the message's content

isWithinEditDuration()

src/commandclient.ts:586

isWithinEditDuration(message: Message): boolean

kill()

src/commandclient.ts:538

kill(): void

on()

src/commandclient.ts:1064

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

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since v0.1.101

Parameters

event

string | symbol

listener

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

The callback function

on(event: COMMAND_DELETE, listener: (payload: CommandDelete) => any): this

on(event: "commandDelete", listener: (payload: CommandDelete) => any): this

on(event: COMMAND_ERROR, listener: (payload: CommandError) => any): this

on(event: "commandError", listener: (payload: CommandError) => any): this

on(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): this

on(event: "commandFail", listener: (payload: CommandFail) => any): this

on(event: COMMAND_NONE, listener: (payload: CommandNone) => any): this

on(event: "commandNone", listener: (payload: CommandNone) => any): this

on(
  event: COMMAND_PERMISSIONS_FAIL_CLIENT,
  listener: (payload: CommandPermissionsFailClient) => any,
): this

on(
  event: "commandPermissionsFailClient",
  listener: (payload: CommandPermissionsFailClient) => any,
): this

on(
  event: COMMAND_PERMISSIONS_FAIL,
  listener: (payload: CommandPermissionsFail) => any,
): this

on(
  event: "commandPermissionsFail",
  listener: (payload: CommandPermissionsFail) => any,
): this

on(event: COMMAND_RAN, listener: (payload: CommandRan) => any): this

on(event: "commandRan", listener: (payload: CommandRan) => any): this

on(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): this

on(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): this

on(
  event: COMMAND_RESPONSE_DELETE,
  listener: (payload: CommandResponseDelete) => any,
): this

on(
  event: "commandResponseDelete",
  listener: (payload: CommandResponseDelete) => any,
): this

on(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): this

on(event: "commandRunError", listener: (payload: CommandRunError) => any): this

on(event: KILLED, listener: () => any): this

on(event: "killed", listener: () => any): this

Overrides EventSpewer.on

once()

src/commandclient.ts:1092

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

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since v0.3.0

Parameters

event

string | symbol

listener

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

The callback function

once(event: COMMAND_DELETE, listener: (payload: CommandDelete) => any): this

once(event: "commandDelete", listener: (payload: CommandDelete) => any): this

once(event: COMMAND_ERROR, listener: (payload: CommandError) => any): this

once(event: "commandError", listener: (payload: CommandError) => any): this

once(event: COMMAND_FAIL, listener: (payload: CommandFail) => any): this

once(event: "commandFail", listener: (payload: CommandFail) => any): this

once(event: COMMAND_NONE, listener: (payload: CommandNone) => any): this

once(event: "commandNone", listener: (payload: CommandNone) => any): this

once(
  event: COMMAND_PERMISSIONS_FAIL_CLIENT,
  listener: (payload: CommandPermissionsFailClient) => any,
): this

once(
  event: "commandPermissionsFailClient",
  listener: (payload: CommandPermissionsFailClient) => any,
): this

once(
  event: COMMAND_PERMISSIONS_FAIL,
  listener: (payload: CommandPermissionsFail) => any,
): this

once(
  event: "commandPermissionsFail",
  listener: (payload: CommandPermissionsFail) => any,
): this

once(event: COMMAND_RAN, listener: (payload: CommandRan) => any): this

once(event: "commandRan", listener: (payload: CommandRan) => any): this

once(event: COMMAND_RATELIMIT, listener: (payload: CommandRatelimit) => any): this

once(event: "commandRatelimit", listener: (payload: CommandRatelimit) => any): this

once(
  event: COMMAND_RESPONSE_DELETE,
  listener: (payload: CommandResponseDelete) => any,
): this

once(
  event: "commandResponseDelete",
  listener: (payload: CommandResponseDelete) => any,
): this

once(event: COMMAND_RUN_ERROR, listener: (payload: CommandRunError) => any): this

once(event: "commandRunError", listener: (payload: CommandRunError) => any): this

once(event: KILLED, listener: () => any): this

once(event: "killed", listener: () => any): this

Overrides EventSpewer.once

onCommandCancel()

optional src/commandclient.ts:124

onCommandCancel(context: Context, command: Command): unknown

onCommandCheck()

optional src/commandclient.ts:123

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

onMessageCancel()

optional src/commandclient.ts:126

onMessageCancel(context: Context): unknown

onMessageCheck()

optional src/commandclient.ts:125

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

onPrefixCheck()

optional src/commandclient.ts:127

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

resetCommands()

async src/commandclient.ts:417

resetCommands(): Promise<void>

run()

async src/commandclient.ts:545

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

setActivateOnEdits()

src/commandclient.ts:257

setActivateOnEdits(value: boolean): void

setMaxEditDuration()

src/commandclient.ts:261

setMaxEditDuration(value: number): void

setMentionsEnabled()

src/commandclient.ts:269

setMentionsEnabled(value: boolean): void

setPrefixSpace()

src/commandclient.ts:273

setPrefixSpace(value: boolean): void

setSubscriptions()

src/commandclient.ts:527

setSubscriptions(): void

storeReply()

src/commandclient.ts:562

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

subscribe()

src/commandclient.ts:1120

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