repl.ReplOptions

interface ReplOptions

• breakEvalOnSigint?: boolean

  Stop evaluating the current piece of code when SIGINT is received, i.e. Ctrl+C is pressed. This cannot be used together with a custom eval function.

• completer?: Completer | AsyncCompleter

  An optional function used for custom Tab auto completion.

• eval?: REPLEval

  The function to be used when evaluating each given line of input. Default: an async wrapper for the JavaScript eval() function. An eval function can error with repl.Recoverable to indicate the input was incomplete and prompt for additional lines.

• ignoreUndefined?: boolean

  If true, specifies that the default writer will not output the return value of a command if it evaluates to undefined.

• input?: ReadableStream

  The Readable stream from which REPL input will be read.

• output?: WritableStream

  The Writable stream to which REPL output will be written.

• preview?: boolean

  Defines if the repl prints output previews or not.

• prompt?: string

  The input prompt to display.

• replMode?: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT

  A flag that specifies whether the default evaluator executes all JavaScript commands in strict mode or default (sloppy) mode. Accepted values are:

  • repl.REPL_MODE_SLOPPY - evaluates expressions in sloppy mode.
  • repl.REPL_MODE_STRICT - evaluates expressions in strict mode. This is equivalent to prefacing every repl statement with 'use strict'.
• terminal?: boolean

  If true, specifies that the output should be treated as a TTY terminal, and have ANSI/VT100 escape codes written to it. Default: checking the value of the isTTY property on the output stream upon instantiation.

• useColors?: boolean

  If true, specifies that the default writer function should include ANSI color styling to REPL output. If a custom writer function is provided then this has no effect.

• useGlobal?: boolean

  If true, specifies that the default evaluation function will use the JavaScript global as the context as opposed to creating a new separate context for the REPL instance. The node CLI REPL sets this value to true.

• writer?: REPLWriter

  The function to invoke to format the output of each command before writing to output.