CommandBuilder

Constructor

new CommandBuilder(name)

The CommandBuilder class: allows you to simply generate a Command.

name

The name of the generated command

{String}

No value returned

Example

          const kimiko = require("kimiko");

let myCommand = new kimiko.CommandBuilder("josh:help")
  .setUsage("<command> [command]")
  .setDescription("Prints out all of the help you'd need to use my nice bot!")
  .setAliases("help", "joshelp")
  .setExecutor(require("commands/josh/help"))
  .build();

Methods

build() → {Command}

Builds the CommandBuilder into a Command

No arguments

The built command

setAliases(…aliases) → {CommandBuilder}

Sets the aliases for the command

… aliases

{String}

This CommandBuilder instance

{CommandBuilder}

setDescription(description) → {CommandBuilder}

Sets the description for the command

description

{String}

This CommandBuilder instance

{CommandBuilder}

setExecutor(executor) → {CommandBuilder}

Sets the executor for the command

executor

{Command#executor}

This CommandBuilder instance

{CommandBuilder}

setPermissionRequired(permissionRequired) → {CommandBuilder}

Sets the required permission for the command

permissionRequired

{String}

This CommandBuilder instance

{CommandBuilder}

setTabCompleter(tabCompleter) → {CommandBuilder}

Sets the tab completer for the command

tabCompleter

{Command#tabCompleter}

This CommandBuilder instance

{CommandBuilder}

setUsage(usage) → {CommandBuilder}

Sets the usage for the command

usage

{String}

This CommandBuilder instance

{CommandBuilder}

` : '' ?>