Class CommandRouter

constructor

• new CommandRouter(opts?: CommandRouterOptions): CommandRouter

  Parameters

  • Optionalopts: CommandRouterOptions

  Returns CommandRouter

caseInsensitive

Readonlycommands

ownerJids

prefixes

categories

• categories(opts?: { includeHidden?: boolean }): string[]

  Parameters

  • Optionalopts: { includeHidden?: boolean }

  Returns string[]

command

• command(name: string, handler: CommandHandler): this

  Parameters

  • name: string
  • handler: CommandHandler

  Returns this

• command(def: CommandDefinition): this

  Parameters

  • def: CommandDefinition

  Returns this

cooldownRemaining

• cooldownRemaining(name: string, sender: string): number

  Parameters

  • name: string
  • sender: string

  Returns number

describe

• describe(name: string, opts?: { prefix?: string }): string | null

  Parameters

  • name: string
  • Optionalopts: { prefix?: string }

  Returns string | null

get

• get(name: string): CommandDefinition | undefined

  Parameters

  • name: string

  Returns CommandDefinition | undefined

handle

• handle(ctx: Context): Promise<HandleResult>

  Parameters

  • ctx: Context

  Returns Promise<HandleResult>

has

• has(name: string): boolean

  Parameters

  • name: string

  Returns boolean

help

• help(
      opts?: {
          category?: string;
          includeHidden?: boolean;
          prefix?: string;
          title?: string;
      },
  ): string

  Parameters

  • Optionalopts: { category?: string; includeHidden?: boolean; prefix?: string; title?: string }

  Returns string

isOwner

• isOwner(jid: string | undefined): boolean

  Parameters

  • jid: string | undefined

  Returns boolean

list

• list(opts?: { includeHidden?: boolean }): CommandDefinition[]

  Parameters

  • Optionalopts: { includeHidden?: boolean }

  Returns CommandDefinition[]

middleware

• middleware(): (ctx: Context, next: () => Promise<void>) => Promise<HandleResult>

  Returns (ctx: Context, next: () => Promise<void>) => Promise<HandleResult>

register

• register(defs: CommandDefinition[]): this

  Parameters

  • defs: CommandDefinition[]

  Returns this

remove

• remove(name: string): boolean

  Parameters

  • name: string

  Returns boolean

resetCooldown

• resetCooldown(name?: string, sender?: string): void

  Parameters

  • Optionalname: string
  • Optionalsender: string

  Returns void