Node.js REPLServer.defineCommand(keyword, cmd)用法及代码示例

replServer.defineCommand(keyword, cmd)

参数

• keyword <string>命令关键字 (没有一个领先的.特点)。
• cmd <Object> | <Function> 处理命令时调用的函数。

replServer.defineCommand() 方法用于向 REPL 实例添加新的带有 . 前缀的命令。通过键入 . 后跟 keyword 来调用此类命令。 cmd 是具有以下属性的 Function 或 Object：

• help <string> 输入.help 时显示的帮助文本(可选)。
• action <Function> 要执行的函数，可选择接受单个字符串参数。

以下示例显示了添加到 REPL 实例的两个新命令：

const repl = require('node:repl');

const replServer = repl.start({ prompt: '> ' });
replServer.defineCommand('sayhello', {
  help: 'Say hello',
  action(name) {
    this.clearBufferedCommand();
    console.log(`Hello, ${name}!`);
    this.displayPrompt();
  }
});
replServer.defineCommand('saybye', function saybye() {
  console.log('Goodbye!');
  this.close();
});

然后可以在 REPL 实例中使用新命令：

> .sayhello Node.js User
Hello, Node.js User!
> .saybye
Goodbye!