CommandHandler | discord-rose

Utility in charge of holding and running commands

Hierarchy

CommandHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CommandHandler(worker: Worker): CommandHandler

- Defined in src/structures/CommandHandler.ts:44
Create's new Command Handler

Parameters
- worker: Worker
  
  Worker
Returns CommandHandler

Properties

CommandContext

CommandContext: typeof CommandContext = ...

SlashCommandContext

SlashCommandContext: typeof SlashCommandContext = ...

Optional commands

commands: Collection<CommandType, CommandOptions>

middlewares

middlewares: MiddlewareFunction[] = []

Optional prefixFunction

prefixFunction: (message: APIMessage) => string | string[] | Promise<string | string[]>

Type declaration

- (message: APIMessage): string | string[] | Promise<string | string[]>
- Parameters
  - message: APIMessage
  Returns string | string[] | Promise<string | string[]>

Methods

add

add(command: CommandOptions): CommandHandler

- Defined in src/structures/CommandHandler.ts:259
Adds a command to the command handler

example

worker.commands .add({ command: 'hello', exec: (ctx) => { ctx.reply('World!') } })

Parameters
- command: CommandOptions
  
  Command data, be sure to add exec() and command:
Returns CommandHandler

this

error

error(fn: (ctx: CommandContext, error: CommandError) => void): CommandHandler

- Defined in src/structures/CommandHandler.ts:229
Defines an error handler replacing the default one

example

worker.commands .error((ctx, error) => { ctx.send(Error: ${error.message}) })

Parameters
- fn: (ctx: CommandContext, error: CommandError) => void
  
  Function to handle error
  - - (ctx: CommandContext, error: CommandError): void
    - Parameters
      - ctx: CommandContext
      - error: CommandError
      Returns void
Returns CommandHandler

this

errorFunction

errorFunction(ctx: CommandContext, err: CommandError): void

- Defined in src/structures/CommandHandler.ts:118
Parameters
- ctx: CommandContext
- err: CommandError
Returns void

find

find(command: string, interaction?: boolean): undefined | CommandOptions

- Defined in src/structures/CommandHandler.ts:302
Gets a command from registry

Parameters
- command: string
  
  Command name to fetch
- Optional interaction: boolean
  
  Whether or not to look for interactions
Returns undefined | CommandOptions

Command

findCommand

findCommand(command: string): undefined | CommandOptions

- Defined in src/structures/CommandHandler.ts:316
Gets a command from registry

deprecated

Use the new .find() function

Parameters
- command: string
  
  Command name to fetch
Returns undefined | CommandOptions

Command

load

load(directory: string): CommandHandler

- Defined in src/structures/CommandHandler.ts:143
Load a directory of CommandOptions commands (will also load sub-folders)

Parameters
- directory: string
  
  Absolute directory full of command files
Returns CommandHandler

middleware

middleware(fn: MiddlewareFunction): CommandHandler

- Defined in src/structures/CommandHandler.ts:240
Adds a global middleware function

Parameters
- fn: MiddlewareFunction
  
  Middleware function
Returns CommandHandler

this

options

options(opts: CommandHandlerOptions): CommandHandler

- Defined in src/structures/CommandHandler.ts:174
Sets Command Handler options

Parameters
- opts: CommandHandlerOptions
  
  Options
Returns CommandHandler

this

prefix

prefix(fn: string | string[] | ((message: APIMessage) => string | string[] | Promise<string | string[]>)): CommandHandler

- Defined in src/structures/CommandHandler.ts:197
Sets a prefix

example

worker.commands .prefix('!') // or .prefix(['!', '+']) // or .prefix((message) => { return db.getPrefix(message.guild_id) })

Parameters
- fn: string | string[] | ((message: APIMessage) => string | string[] | Promise<string | string[]>)
  
  String of prefix or Function to choose prefix with
Returns CommandHandler

this

setPrefix

setPrefix(fn: string | string[] | ((message: APIMessage) => string | string[] | Promise<string | string[]>)): CommandHandler

- Defined in src/structures/CommandHandler.ts:213
Sets a prefix

deprecated

Use the new .prefix() function

Parameters
- fn: string | string[] | ((message: APIMessage) => string | string[] | Promise<string | string[]>)
  
  String of prefix or Function to choose prefix with
Returns CommandHandler

this

setupInteractions

setupInteractions(): Promise<void>

- Defined in src/structures/CommandHandler.ts:52
Returns Promise<void>

Generated using TypeDoc