Koishi

# 指令 (Command)

指令系统是 Koishi 的核心功能之一。通过 ctx.command() 方法获得的是指令的实例，它含有下面的方法：

# cmd.option(rawName, description?, config?)

为指令添加一个选项。

  • rawName: string 选项的名字和参数
  • description: string 选项的描述
  • config: OptionConfig
  • 返回值: this

# cmd.removeOption(name)

删除一个选项。注意：如果你为一个选项注册了多个别名，则删除任何一个别名都相当于删除整个选项。

  • name: string 指令的名称
  • 返回值: this

# cmd.usage(text)

为指令添加使用方法。多次调用此方法只会保留最后一次的定义。

  • text: string 使用方法说明
  • 返回值: this

# cmd.example(example)

为指令添加使用示例。多次调用此方法会一并保留并显示在帮助的最后面。

  • example: text 使用示例
  • 返回值: this

# cmd.action(action)

为指令添加执行函数。

  • action: (config: ParsedCommandLine, ...args: string[]) => any 执行函数。这个函数的第一个参数是 ParsedCommandLine 对象，之后的每个参数都是字符串，表示从指令调用中解析出来的参数
  • 返回值: this

# cmd.userFields(fields)

如果指令需要用到用户数据，你可以提前声明，这样有助于合并多次请求，从而提高性能。

  • fields: Iterator<UserField> 要请求的用户字段
  • 返回值: this

# cmd.groupFields(fields)

如果指令需要用到群数据，你可以提前声明，这样有助于合并多次请求，从而提高性能。

  • fields: Iterator<GroupField> 要请求的群字段
  • 返回值: this

# cmd.alias(...names)

设置指令别名。

  • names: string[] 要设置的别名
  • 返回值: this

# cmd.shortcut(name, config?)

设置快捷方式。

# cmd.subcommand(name, description?, config?)

注册或修改子指令。子指令会继承当期指令的上下文。

  • rawName: string 指令名以及可能的参数
  • description: string 指令的描述
  • config: CommandConfig 指令的配置
  • 返回值：Command 注册或修改的指令

# cmd.parse(message)

解析一段指令调用文本。

  • message: string 要解析的文本（开头不要包含指令名和前缀）
  • 返回值: ParseResult 解析结果。包含 ParsedCommandLine 对象 的 args, options, unknown 和 rest 四个属性

# cmd.execute(config, next?)

执行本指令。

# cmd.end()

返回当前指令所在的上下文，可用于链式调用。

  • 返回值: Context 当前指令所在的上下文

← 数据库 (Database) →