REPLServer

external class REPLServer : _Interface(source)

Instances of repl.REPLServer are created using the {@link start} method or directly using the JavaScript new keyword.

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

const options = { useColors: true };

const firstInstance = repl.start(options);
const secondInstance = new repl.REPLServer(options);

Since

v0.1.91

Constructors

REPLServer

constructor()

Properties

commands

val commands: ReadOnlyDict<REPLCommand>

The commands registered via replServer.defineCommand().

completer

val completer: Any

Specified in the REPL options, this is the function to use for custom Tab auto-completion.

context

val context: Context

The vm.Context provided to the eval function to be used for JavaScript evaluation.

cursor

val cursor: Double

The cursor position relative to rl.line.

editorMode

val editorMode: Boolean

A value indicating whether the REPL is currently in "editor mode".

eval

val eval: REPLEval

Specified in the REPL options, this is the function to be used when evaluating each given line of input. If not specified in the REPL options, this is an async wrapper for the JavaScript eval() function.

ignoreUndefined

val ignoreUndefined: Boolean

Specified in the REPL options, this is a value indicating whether the default writer function should output the result of a command if it evaluates to undefined.

input

val input: ReadableStream

The Readable stream from which REPL input will be read.

inputStream

val inputStream: ReadableStream

last

val last: Any?

The last evaluation result from the REPL (assigned to the _ variable inside of the REPL).

lastError

val lastError: Any?

The last error raised inside the REPL (assigned to the _error variable inside of the REPL).

line

val line: String

The current input data being processed by node.

output

val output: WritableStream

The Writable stream to which REPL output will be written.

outputStream

val outputStream: WritableStream

replMode

val replMode: Any

Specified in the REPL options, this is a flag that specifies whether the default eval function should execute all JavaScript commands in strict mode or default (sloppy) mode. Possible values are:

terminal

val terminal: Boolean

underscoreAssigned

val underscoreAssigned: Boolean

A value indicating whether the _ variable has been assigned.

underscoreErrAssigned

val underscoreErrAssigned: Boolean

A value indicating whether the _error variable has been assigned.

useColors

val useColors: Boolean

Specified in the REPL options, this is a value indicating whether the default writer function should include ANSI color styling to REPL output.

useGlobal

val useGlobal: Boolean

Specified in the REPL options, this is a value indicating whether the default eval function will use the JavaScript global as the context as opposed to creating a new separate context for the REPL instance.

writer

val writer: REPLWriter

Specified in the REPL options, this is the function to invoke to format the output of each command before writing to outputStream. If not specified in the REPL options, this will be a wrapper for util.inspect.

Functions

addListener

fun addListener(event: InterfaceEvent.CLOSE, listener: () -> Unit)

fun addListener(event: InterfaceEvent.HISTORY, listener: (ReadonlyArray<String>) -> Unit)

fun addListener(event: InterfaceEvent.LINE, listener: (input: String) -> Unit)

fun addListener(event: InterfaceEvent.PAUSE, listener: () -> Unit)

fun addListener(event: InterfaceEvent.RESUME, listener: () -> Unit)

fun addListener(event: InterfaceEvent.SIGCONT, listener: () -> Unit)

fun addListener(event: InterfaceEvent.SIGINT, listener: () -> Unit)

fun addListener(event: InterfaceEvent.SIGTSTP, listener: () -> Unit)

fun addListener(event: REPLServerEvent.CLOSE, listener: () -> Unit)

fun addListener(event: REPLServerEvent.EXIT, listener: () -> Unit)

fun addListener(event: REPLServerEvent.LINE, listener: (input: String) -> Unit)

fun addListener(event: REPLServerEvent.PAUSE, listener: () -> Unit)

fun addListener(event: REPLServerEvent.RESET, listener: (context: Context) -> Unit)

fun addListener(event: REPLServerEvent.RESUME, listener: () -> Unit)

fun addListener(event: REPLServerEvent.SIGCONT, listener: () -> Unit)

fun addListener(event: REPLServerEvent.SIGINT, listener: () -> Unit)

fun addListener(event: REPLServerEvent.SIGTSTP, listener: () -> Unit)

open override fun addListener(event: String, listener: Function<Unit>)

events.EventEmitter

clearBufferedCommand

fun clearBufferedCommand()

The replServer.clearBufferedCommand() method clears any command that has been buffered but not yet executed. This method is primarily intended to be called from within the action function for commands registered using the replServer.defineCommand() method.

fun close()

The rl.close() method closes the Interface instance and relinquishes control over the input and output streams. When called, the 'close' event will be emitted.

defineCommand

fun defineCommand(keyword: String, cmd: REPLCommandAction)

fun defineCommand(keyword: String, cmd: REPLCommand)

The replServer.defineCommand() method is used to add new .\-prefixed commands to the REPL instance. Such commands are invoked by typing a . followed by the keyword. The cmd is either a Function or an Object with the following properties:

displayPrompt

fun displayPrompt(preserveCursor: Boolean = definedExternally)

The replServer.displayPrompt() method readies the REPL instance for input from the user, printing the configured prompt to a new line in the output and resuming the input to accept new input.

emit

fun emit(event: InterfaceEvent.CLOSE): Boolean

fun emit(event: InterfaceEvent.PAUSE): Boolean

fun emit(event: InterfaceEvent.RESUME): Boolean

fun emit(event: InterfaceEvent.SIGCONT): Boolean

fun emit(event: InterfaceEvent.SIGINT): Boolean

fun emit(event: InterfaceEvent.SIGTSTP): Boolean

fun emit(event: InterfaceEvent.HISTORY, history: ReadonlyArray<String>): Boolean

fun emit(event: InterfaceEvent.LINE, input: String): Boolean

fun emit(event: REPLServerEvent.CLOSE): Boolean

fun emit(event: REPLServerEvent.EXIT): Boolean

fun emit(event: REPLServerEvent.PAUSE): Boolean

fun emit(event: REPLServerEvent.RESUME): Boolean

fun emit(event: REPLServerEvent.SIGCONT): Boolean

fun emit(event: REPLServerEvent.SIGINT): Boolean

fun emit(event: REPLServerEvent.SIGTSTP): Boolean

open override fun emit(event: Symbol, vararg args: Any?): Boolean

open override fun emit(event: String, vararg args: Any?): Boolean

fun emit(event: REPLServerEvent.LINE, input: String): Boolean

fun emit(event: REPLServerEvent.RESET, context: Context): Boolean

eventNames

fun eventNames(): Array<Any>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

getCursorPos

fun getCursorPos(): CursorPos

Returns the real position of the cursor in relation to the input prompt + string. Long input (wrapping) strings, as well as multiple line prompts are included in the calculations.

getMaxListeners

fun getMaxListeners(): Double

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

getPrompt

fun getPrompt(): String

The rl.getPrompt() method returns the current prompt used by rl.prompt().

fun on(event: InterfaceEvent.CLOSE, listener: () -> Unit)

fun on(event: InterfaceEvent.HISTORY, listener: (ReadonlyArray<String>) -> Unit)

fun on(event: InterfaceEvent.LINE, listener: (input: String) -> Unit)

fun on(event: InterfaceEvent.PAUSE, listener: () -> Unit)

fun on(event: InterfaceEvent.RESUME, listener: () -> Unit)

fun on(event: InterfaceEvent.SIGCONT, listener: () -> Unit)

fun on(event: InterfaceEvent.SIGINT, listener: () -> Unit)

fun on(event: InterfaceEvent.SIGTSTP, listener: () -> Unit)

open override fun on(event: String, listener: Function<Unit>)

fun on(event: REPLServerEvent.CLOSE, listener: () -> Unit)

fun on(event: REPLServerEvent.EXIT, listener: () -> Unit)

fun on(event: REPLServerEvent.LINE, listener: (input: String) -> Unit)

fun on(event: REPLServerEvent.PAUSE, listener: () -> Unit)

fun on(event: REPLServerEvent.RESET, listener: (context: Context) -> Unit)

fun on(event: REPLServerEvent.RESUME, listener: () -> Unit)

fun on(event: REPLServerEvent.SIGCONT, listener: () -> Unit)

fun on(event: REPLServerEvent.SIGINT, listener: () -> Unit)

fun on(event: REPLServerEvent.SIGTSTP, listener: () -> Unit)

once

fun once(event: InterfaceEvent.CLOSE, listener: () -> Unit)

fun once(event: InterfaceEvent.HISTORY, listener: (ReadonlyArray<String>) -> Unit)

fun once(event: InterfaceEvent.LINE, listener: (input: String) -> Unit)

fun once(event: InterfaceEvent.PAUSE, listener: () -> Unit)

fun once(event: InterfaceEvent.RESUME, listener: () -> Unit)

fun once(event: InterfaceEvent.SIGCONT, listener: () -> Unit)

fun once(event: InterfaceEvent.SIGINT, listener: () -> Unit)

fun once(event: InterfaceEvent.SIGTSTP, listener: () -> Unit)

open override fun once(event: String, listener: Function<Unit>)

fun once(event: REPLServerEvent.CLOSE, listener: () -> Unit)

fun once(event: REPLServerEvent.EXIT, listener: () -> Unit)

fun once(event: REPLServerEvent.LINE, listener: (input: String) -> Unit)

fun once(event: REPLServerEvent.PAUSE, listener: () -> Unit)

fun once(event: REPLServerEvent.RESET, listener: (context: Context) -> Unit)

fun once(event: REPLServerEvent.RESUME, listener: () -> Unit)

fun once(event: REPLServerEvent.SIGCONT, listener: () -> Unit)

fun once(event: REPLServerEvent.SIGINT, listener: () -> Unit)

fun once(event: REPLServerEvent.SIGTSTP, listener: () -> Unit)

pause

fun pause()

The rl.pause() method pauses the input stream, allowing it to be resumed later if necessary.

prependListener

fun prependListener(event: InterfaceEvent.CLOSE, listener: () -> Unit)

fun prependListener(event: InterfaceEvent.HISTORY, listener: (ReadonlyArray<String>) -> Unit)

fun prependListener(event: InterfaceEvent.LINE, listener: (input: String) -> Unit)

fun prependListener(event: InterfaceEvent.PAUSE, listener: () -> Unit)

fun prependListener(event: InterfaceEvent.RESUME, listener: () -> Unit)

fun prependListener(event: InterfaceEvent.SIGCONT, listener: () -> Unit)

fun prependListener(event: InterfaceEvent.SIGINT, listener: () -> Unit)

fun prependListener(event: InterfaceEvent.SIGTSTP, listener: () -> Unit)

open override fun prependListener(event: String, listener: Function<Unit>)

fun prependListener(event: REPLServerEvent.CLOSE, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.EXIT, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.LINE, listener: (input: String) -> Unit)

fun prependListener(event: REPLServerEvent.PAUSE, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.RESET, listener: (context: Context) -> Unit)

fun prependListener(event: REPLServerEvent.RESUME, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.SIGCONT, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.SIGINT, listener: () -> Unit)

fun prependListener(event: REPLServerEvent.SIGTSTP, listener: () -> Unit)

prependOnceListener

fun prependOnceListener(event: InterfaceEvent.CLOSE, listener: () -> Unit)

fun prependOnceListener(event: InterfaceEvent.HISTORY, listener: (ReadonlyArray<String>) -> Unit)

fun prependOnceListener(event: InterfaceEvent.LINE, listener: (input: String) -> Unit)

fun prependOnceListener(event: InterfaceEvent.PAUSE, listener: () -> Unit)

fun prependOnceListener(event: InterfaceEvent.RESUME, listener: () -> Unit)

fun prependOnceListener(event: InterfaceEvent.SIGCONT, listener: () -> Unit)

fun prependOnceListener(event: InterfaceEvent.SIGINT, listener: () -> Unit)

fun prependOnceListener(event: InterfaceEvent.SIGTSTP, listener: () -> Unit)

open override fun prependOnceListener(event: String, listener: Function<Unit>)

fun prependOnceListener(event: REPLServerEvent.CLOSE, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.EXIT, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.LINE, listener: (input: String) -> Unit)

fun prependOnceListener(event: REPLServerEvent.PAUSE, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.RESET, listener: (context: Context) -> Unit)

fun prependOnceListener(event: REPLServerEvent.RESUME, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.SIGCONT, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.SIGINT, listener: () -> Unit)

fun prependOnceListener(event: REPLServerEvent.SIGTSTP, listener: () -> Unit)

prompt

fun prompt(preserveCursor: Boolean = definedExternally)

The rl.prompt() method writes the Interface instances configuredprompt to a new line in output in order to provide a user with a new location at which to provide input.

question

fun question(query: String, callback: (answer: String) -> Unit)

The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input, then invokes the callback function passing the provided input as the first argument.

fun question(query: String, options: Abortable, callback: (answer: String) -> Unit)

resume

fun resume()

The rl.resume() method resumes the input stream if it has been paused.

setMaxListeners

fun setMaxListeners(n: Number)

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

setPrompt

fun setPrompt(prompt: String)

The rl.setPrompt() method sets the prompt that will be written to output whenever rl.prompt() is called.

setupHistory

fun setupHistory(path: String, callback: (JsError?, repl: Unit) -> Unit)

Initializes a history log file for the REPL instance. When executing the Node.js binary and using the command-line REPL, a history file is initialized by default. However, this is not the case when creating a REPL programmatically. Use this method to initialize a history log file when working with REPL instances programmatically.

write

fun write(data: String, key: Key = definedExternally)

fun write(data: Buffer, key: Key = definedExternally)

The rl.write() method will write either data or a key sequence identified by key to the output. The key argument is supported only if output is a TTY text terminal. See TTY keybindings for a list of key combinations.

fun write(data: String?, key: Key)

fun write(data: Buffer?, key: Key)