Interface

The cursor position relative to rl.line.

The current input data being processed by node.

Alias for emitter.on(eventName, listener).

events.EventEmitter

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.

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

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

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.

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

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

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Returns a copy of the array of listeners for the event named eventName.

Alias for emitter.removeListener().

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

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

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

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.

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.

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.

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Removes all listeners, or those of the specified eventName.

Removes the specified listener from the listener array for the event named eventName.

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

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.

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

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.