Node.js v24.0.0 文档

命令和特殊键#

所有 REPL 实例都支持以下特殊命令：

• .break：当输入多行表达式时，输入 .break 命令（或按 Ctrl+C）以中止进一步输入或处理该表达式。
• .clear：将 REPL context 重置为一个空对象，并清除任何正在输入的多行表达式。
• .exit：关闭 I/O 流，导致 REPL 退出。
• .help：显示此特殊命令列表。
• .save：将当前 REPL 会话保存到文件：> .save ./file/to/save.js
• .load：将文件加载到当前 REPL 会话中。 > .load ./file/to/load.js
• .editor：进入编辑器模式（Ctrl+D 完成，Ctrl+C 取消）。

> .editor
// Entering editor mode (^D to finish, ^C to cancel)
function welcome(name) {
  return `Hello ${name}!`;
}

welcome('Node.js User');

// ^D
'Hello Node.js User!'
> copy

REPL 中的以下按键组合具有以下特殊效果：

• Ctrl+C：按一次的效果与 .break 命令相同。 在空白行上按两次的效果与 .exit 命令相同。
• Ctrl+D：效果与 .exit 命令相同。
• Tab：在空白行上按下时，显示全局和局部（作用域）变量。 在输入其他内容时按下时，显示相关的自动完成选项。

有关与反向 i 搜索相关的键绑定，请参阅 reverse-i-search。 有关所有其他键绑定，请参阅 TTY 键绑定。

默认求值#

默认情况下，repl.REPLServer 的所有实例都使用求值 JavaScript 表达式并提供对 Node.js 内置模块的访问的求值函数。 通过在创建 repl.REPLServer 实例时传入替代求值函数，可以覆盖此默认行为。

> 1 + 1
2
> const m = 2
undefined
> m + 1
3 copy

import repl from 'node:repl';
const msg = 'message';

repl.start('> ').context.m = msg;const repl = require('node:repl');
const msg = 'message';

repl.start('> ').context.m = msg;copy

$ node repl_test.js
> m
'message' copy

import repl from 'node:repl';
const msg = 'message';

const r = repl.start('> ');
Object.defineProperty(r.context, 'm', {
  configurable: false,
  enumerable: true,
  value: msg,
});const repl = require('node:repl');
const msg = 'message';

const r = repl.start('> ');
Object.defineProperty(r.context, 'm', {
  configurable: false,
  enumerable: true,
  value: msg,
});copy

> fs.createReadStream('./some/file'); copy

> [ 'a', 'b', 'c' ]
[ 'a', 'b', 'c' ]
> _.length
3
> _ += 1
Expression assignment to _ now disabled.
4
> 1 + 1
2
> _
4 copy

> throw new Error('foo');
Uncaught Error: foo
> _error.message
'foo' copy

> await Promise.resolve(123)
123
> await Promise.reject(new Error('REPL await'))
Uncaught Error: REPL await
    at REPL2:1:54
> const timeout = util.promisify(setTimeout);
undefined
> const old = Date.now(); await timeout(1000); console.log(Date.now() - old);
1002
undefined copy

> const m = await Promise.resolve(123)
undefined
> m
123
> m = await Promise.resolve(234)
234
// redeclaring the constant does error
> const m = await Promise.resolve(345)
Uncaught SyntaxError: Identifier 'm' has already been declared copy

反向 i 搜索#

REPL 支持类似于 ZSH 的双向反向 i 搜索。 它通过 Ctrl+R 触发以向后搜索，通过 Ctrl+S 触发以向前搜索。

重复的历史记录条目将被跳过。

只要按下与反向搜索不对应的任何键，条目就会被接受。 可以通过按 Esc 或 Ctrl+C 取消。

立即更改方向会从当前位置在预期方向上搜索下一个条目。

自定义求值函数#

创建新的 repl.REPLServer 时，可以提供自定义求值函数。 例如，这可用于实现完全自定义的 REPL 应用程序。

求值函数接受以下四个参数：

• code <string> 要执行的代码（例如 1 + 1）。
• context <Object> 执行代码的上下文。 这可以是 JavaScript global 上下文，也可以是特定于 REPL 实例的上下文，具体取决于 useGlobal 选项。
• replResourceName <string> 与当前代码评估关联的 REPL 资源的标识符。 这对于调试目的很有用。
• callback <Function> 代码评估完成后要调用的函数。 回调函数接受两个参数：
  • 如果在评估期间发生错误，则提供错误对象；如果未发生错误，则提供 null/undefined。
  • 代码评估的结果（如果提供了错误，则此结果无关紧要）。

以下示例说明了一个 REPL，它对给定的数字求平方，如果提供的输入实际上不是数字，则会打印一个错误：

import repl from 'node:repl';

function byThePowerOfTwo(number) {
  return number * number;
}

function myEval(code, context, replResourceName, callback) {
  if (isNaN(code)) {
    callback(new Error(`${code.trim()} is not a number`));
  } else {
    callback(null, byThePowerOfTwo(code));
  }
}

repl.start({ prompt: 'Enter a number: ', eval: myEval });const repl = require('node:repl');

function byThePowerOfTwo(number) {
  return number * number;
}

function myEval(code, context, replResourceName, callback) {
  if (isNaN(code)) {
    callback(new Error(`${code.trim()} is not a number`));
  } else {
    callback(null, byThePowerOfTwo(code));
  }
}

repl.start({ prompt: 'Enter a number: ', eval: myEval });copy

function myEval(cmd, context, filename, callback) {
  let result;
  try {
    result = vm.runInThisContext(cmd);
  } catch (e) {
    if (isRecoverableError(e)) {
      return callback(new repl.Recoverable(e));
    }
  }
  callback(null, result);
}

function isRecoverableError(error) {
  if (error.name === 'SyntaxError') {
    return /^(Unexpected end of input|Unexpected token)/.test(error.message);
  }
  return false;
} copy

自定义 REPL 输出#

默认情况下，repl.REPLServer 实例在使用 util.inspect() 方法格式化输出后，再将输出写入到提供的 Writable 流（默认为 process.stdout）。showProxy 检查选项默认设置为 true，colors 选项会根据 REPL 的 useColors 选项设置为 true。

可以在构造时指定 useColors 布尔选项，以指示默认的写入器使用 ANSI 样式代码来着色 util.inspect() 方法的输出。

如果 REPL 作为独立程序运行，还可以通过使用 inspect.replDefaults 属性从 REPL 内部更改 REPL 的 检查默认值，该属性镜像了 util.inspect() 中的 defaultOptions。

> util.inspect.replDefaults.compact = false;
false
> [1]
[
  1
]
> copy

要完全自定义 repl.REPLServer 实例的输出，请在构造时为 writer 选项传入一个新函数。例如，以下示例仅将任何输入文本转换为大写

import repl from 'node:repl';

const r = repl.start({ prompt: '> ', eval: myEval, writer: myWriter });

function myEval(cmd, context, filename, callback) {
  callback(null, cmd);
}

function myWriter(output) {
  return output.toUpperCase();
}const repl = require('node:repl');

const r = repl.start({ prompt: '> ', eval: myEval, writer: myWriter });

function myEval(cmd, context, filename, callback) {
  callback(null, cmd);
}

function myWriter(output) {
  return output.toUpperCase();
}copy

事件: 'exit'#

当 REPL 通过接收到 .exit 命令作为输入、用户按下 Ctrl+C 两次以发出 SIGINT 信号，或按下 Ctrl+D 以发出输入流上的 'end' 信号而退出时，会触发 'exit' 事件。调用监听器回调时不带任何参数。

replServer.on('exit', () => {
  console.log('Received "exit" event from repl!');
  process.exit();
}); copy

事件: 'reset'#

当 REPL 的上下文重置时，会触发 'reset' 事件。当收到 .clear 命令作为输入时会发生这种情况，除非 REPL 使用默认的求值器，并且 repl.REPLServer 实例是用 useGlobal 选项设置为 true 创建的。将使用对 context 对象的引用作为唯一参数来调用监听器回调。

这主要可以用于将 REPL 上下文重新初始化为某些预定义的 state

import repl from 'node:repl';

function initializeContext(context) {
  context.m = 'test';
}

const r = repl.start({ prompt: '> ' });
initializeContext(r.context);

r.on('reset', initializeContext);const repl = require('node:repl');

function initializeContext(context) {
  context.m = 'test';
}

const r = repl.start({ prompt: '> ' });
initializeContext(r.context);

r.on('reset', initializeContext);copy

当执行此代码时，可以修改全局 'm' 变量，然后使用 .clear 命令将其重置为其初始值

$ ./node example.js
> m
'test'
> m = 1
1
> m
1
> .clear
Clearing context...
> m
'test'
> copy

replServer.defineCommand(keyword, cmd)#

• keyword <string> 命令关键字（不带 前导 . 字符）。
• cmd <Object> | <Function> 调用命令时要调用的函数。

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

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

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

import repl from '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();
});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();
});copy

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

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

replServer.displayPrompt([preserveCursor])#

• preserveCursor <boolean>

replServer.displayPrompt() 方法使 REPL 实例准备好接收用户的输入，将配置的 prompt 打印到 output 中的新行，并恢复 input 以接受新的输入。

当输入多行输入时，会打印管道 '|' 而不是 'prompt'。

当 preserveCursor 为 true 时，光标位置将不会重置为 0。

replServer.displayPrompt 方法主要用于从使用 replServer.defineCommand() 方法注册的命令的操作函数中调用。

replServer.clearBufferedCommand()#

replServer.clearBufferedCommand() 方法清除任何已缓冲但尚未执行的命令。此方法主要用于从使用 replServer.defineCommand() 方法注册的命令的操作函数中调用。

replServer.setupHistory(historyPath, callback)#

• historyPath <string> 历史文件的路径
• callback <Function> 在历史记录写入准备好或发生错误时调用
  • err <Error>
  • repl <repl.REPLServer>

为 REPL 实例初始化历史记录日志文件。当执行 Node.js 二进制文件并使用命令行 REPL 时，默认情况下会初始化历史记录文件。但是，以编程方式创建 REPL 时并非如此。使用此方法在以编程方式使用 REPL 实例时初始化历史记录日志文件。

环境变量选项#

可以使用以下环境变量自定义 Node.js REPL 的各种行为

• NODE_REPL_HISTORY: 当给出一个有效的路径时，持久 REPL 历史记录将被保存到指定的文件，而不是用户主目录中的 .node_repl_history。将此值设置为 ''（空字符串）将禁用持久 REPL 历史记录。将从该值中删除空格。在 Windows 平台上，具有空值的环境变量无效，因此请将此变量设置为一个或多个空格以禁用持久 REPL 历史记录。
• NODE_REPL_HISTORY_SIZE: 控制如果历史记录可用，将持久保存多少行历史记录。必须是一个正数。默认值： 1000。
• NODE_REPL_MODE: 可以是 'sloppy' 或 'strict'。默认值： 'sloppy'，它将允许运行非严格模式代码。

持久历史记录#

默认情况下，Node.js REPL 会通过将输入保存到位于用户主目录中的 .node_repl_history 文件，来持久保存 node REPL 会话之间的历史记录。可以通过设置环境变量 NODE_REPL_HISTORY='' 来禁用此功能。

将 Node.js REPL 与高级行编辑器一起使用#

对于高级行编辑器，请使用环境变量 NODE_NO_READLINE=1 启动 Node.js。这将在规范终端设置中启动主 REPL 和调试器 REPL，这将允许与 rlwrap 一起使用。

例如，以下内容可以添加到 .bashrc 文件中

alias node="env NODE_NO_READLINE=1 rlwrap node" copy

在同一进程中启动多个 REPL 实例#

可以针对 Node.js 的单个运行实例创建和运行多个 REPL 实例，这些实例共享一个 global 对象（通过将 useGlobal 选项设置为 true），但具有单独的 I/O 接口。

例如，以下示例在 stdin、Unix 套接字和 TCP 套接字上提供单独的 REPL，所有这些都共享同一个 global 对象

import net from 'node:net';
import repl from 'node:repl';
import process from 'node:process';
import fs from 'node:fs';

let connections = 0;

repl.start({
  prompt: 'Node.js via stdin> ',
  useGlobal: true,
  input: process.stdin,
  output: process.stdout,
});

const unixSocketPath = '/tmp/node-repl-sock';

// If the socket file already exists let's remove it
fs.rmSync(unixSocketPath, { force: true });

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via Unix socket> ',
    useGlobal: true,
    input: socket,
    output: socket,
  }).on('exit', () => {
    socket.end();
  });
}).listen(unixSocketPath);

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via TCP socket> ',
    useGlobal: true,
    input: socket,
    output: socket,
  }).on('exit', () => {
    socket.end();
  });
}).listen(5001);const net = require('node:net');
const repl = require('node:repl');
const fs = require('node:fs');

let connections = 0;

repl.start({
  prompt: 'Node.js via stdin> ',
  useGlobal: true,
  input: process.stdin,
  output: process.stdout,
});

const unixSocketPath = '/tmp/node-repl-sock';

// If the socket file already exists let's remove it
fs.rmSync(unixSocketPath, { force: true });

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via Unix socket> ',
    useGlobal: true,
    input: socket,
    output: socket,
  }).on('exit', () => {
    socket.end();
  });
}).listen(unixSocketPath);

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via TCP socket> ',
    useGlobal: true,
    input: socket,
    output: socket,
  }).on('exit', () => {
    socket.end();
  });
}).listen(5001);copy

从命令行运行此应用程序将在 stdin 上启动一个 REPL。其他 REPL 客户端可以通过 Unix 套接字或 TCP 套接字连接。例如，telnet 可用于连接到 TCP 套接字，而 socat 可用于连接到 Unix 和 TCP 套接字。

通过从基于 Unix 套接字的服务器而不是 stdin 启动 REPL，可以连接到长时间运行的 Node.js 进程而无需重新启动它。

示例#

// repl-server.js
import repl from 'node:repl';
import net from 'node:net';

net
  .createServer((socket) => {
    const r = repl.start({
      prompt: `socket ${socket.remoteAddress}:${socket.remotePort}> `,
      input: socket,
      output: socket,
      terminal: true,
      useGlobal: false,
    });
    r.on('exit', () => {
      socket.end();
    });
    r.context.socket = socket;
  })
  .listen(1337);// repl-server.js
const repl = require('node:repl');
const net = require('node:net');

net
  .createServer((socket) => {
    const r = repl.start({
      prompt: `socket ${socket.remoteAddress}:${socket.remotePort}> `,
      input: socket,
      output: socket,
      terminal: true,
      useGlobal: false,
    });
    r.on('exit', () => {
      socket.end();
    });
    r.context.socket = socket;
  })
  .listen(1337);copy

// repl-client.js
import net from 'node:net';
import process from 'node:process';

const sock = net.connect(1337);

process.stdin.pipe(sock);
sock.pipe(process.stdout);

sock.on('connect', () => {
  process.stdin.resume();
  process.stdin.setRawMode(true);
});

sock.on('close', () => {
  process.stdin.setRawMode(false);
  process.stdin.pause();
  sock.removeListener('close', done);
});

process.stdin.on('end', () => {
  sock.destroy();
  console.log();
});

process.stdin.on('data', (b) => {
  if (b.length === 1 && b[0] === 4) {
    process.stdin.emit('end');
  }
});// repl-client.js
const net = require('node:net');

const sock = net.connect(1337);

process.stdin.pipe(sock);
sock.pipe(process.stdout);

sock.on('connect', () => {
  process.stdin.resume();
  process.stdin.setRawMode(true);
});

sock.on('close', () => {
  process.stdin.setRawMode(false);
  process.stdin.pause();
  sock.removeListener('close', done);
});

process.stdin.on('end', () => {
  sock.destroy();
  console.log();
});

process.stdin.on('data', (b) => {
  if (b.length === 1 && b[0] === 4) {
    process.stdin.emit('end');
  }
});copy

import http from 'node:http';
import repl from 'node:repl';

const server = http.createServer((req, res) => {
  res.setHeader('content-type', 'multipart/octet-stream');

  repl.start({
    prompt: 'curl repl> ',
    input: req,
    output: res,
    terminal: false,
    useColors: true,
    useGlobal: false,
  });
});

server.listen(8000);const http = require('node:http');
const repl = require('node:repl');

const server = http.createServer((req, res) => {
  res.setHeader('content-type', 'multipart/octet-stream');

  repl.start({
    prompt: 'curl repl> ',
    input: req,
    output: res,
    terminal: false,
    useColors: true,
    useGlobal: false,
  });
});

server.listen(8000);copy