repl.start([options])


  • options <Object> | <string>
    • prompt <string> 要显示的输入提示。默认值:'> '(带一个空格)。
    • input <stream.Readable> 将用于读取 REPL 输入的 Readable 流。默认值: process.stdin
    • output <stream.Writable> 将用于写入 REPL 输出的 Writable 流。默认值: process.stdout
    • terminal <boolean> 如果为 true,则指定 output 应被视为 TTY 终端。 默认值: 在实例化时检查 output 流上的 isTTY 属性值。
    • 'eval' <Function> 计算每行时使用的函数 输入。默认: JavaScript 'eval()' 的异步封装器 功能。“评估”函数可能与“repl.”发生错误。可恢复“以表示 输入不完整,且提示了额外行。参见 详情请见自定义评估函数版块。
    • useColors <boolean> 如果为 true,指定默认的 writer 函数应在 REPL 输出中包括 ANSI 颜色样式。如果提供了自定义 writer 函数,则此选项无效。默认值: 如果 REPL 实例的 terminal 值为 true,则检查 output 流是否支持颜色。
    • useGlobal <boolean> 如果为 true,指定默认的评估函数将使用 JavaScript 的 global 作为上下文,而不是为 REPL 实例创建一个新的独立上下文。Node CLI REPL 将此值设置为 true默认值: false
    • ignoreUndefined <boolean> 如果设置为 true,则指定默认的写入器在命令返回值为 undefined 时不会输出该值。默认值: false
    • writer <Function> 在写入 output 之前,用于格式化每个命令输出的函数。默认值: util.inspect()
    • completer <Function> 一个可选函数,用于自定义 Tab 自动补齐。示例见 readline.InterfaceCompleter
    • replMode <symbol> 一个标志,用于指定默认求值器是否以严格模式或默认(宽松)模式执行所有 JavaScript 命令。可接受的值有:
      • 使用 repl.REPL_MODE_SLOPPY 以宽松模式评估表达式。
      • repl.REPL_MODE_STRICT 用于在严格模式下评估表达式。这相当于在每个 REPL 语句前加上 'use strict'
    • breakEvalOnSigint <boolean> 在收到 SIGINT 时停止评估当前代码片段,例如当按下 Ctrl+C 时。该选项不能与自定义 eval 函数一起使用。默认值: false
    • preview <boolean> 定义 repl 是否打印自动补全和输出预览。默认值: 使用默认 eval 函数时为 true,使用自定义 eval 函数时为 false。如果 terminal 为假值,则不会有预览,preview 的值也不会生效。
  • 返回值:<repl.REPLServer>

repl.start() 方法创建并启动一个 repl.REPLServer 实例。

【The repl.start() method creates and starts a repl.REPLServer instance.】

如果 options 是一个字符串,那么它指定了输入提示:

【If options is a string, then it specifies the input prompt:】

import repl from 'node:repl';

// a Unix style prompt
repl.start('$ ');const repl = require('node:repl');

// a Unix style prompt
repl.start('$ ');