_Interface

Instances of the readline.Interface class are constructed using the readline.createInterface() method. Every instance is associated with a single input Readable stream and a single output Writable stream. The output stream is used to print prompts for user input that arrives on, and is read from, the input stream.

Since

v0.1.104

Inheritors

Constructors

Link copied to clipboard
constructor(input: ReadableStream, output: WritableStream = definedExternally, completer: _Completer = definedExternally, terminal: Boolean = definedExternally)

NOTE: According to the documentation:

constructor(input: ReadableStream, output: WritableStream = definedExternally, completer: AsyncCompleter = definedExternally, terminal: Boolean = definedExternally)

NOTE: According to the documentation:

constructor(options: _ReadLineOptions)

NOTE: According to the documentation:

Properties

Link copied to clipboard
open external val closeEvent: EventInstance<Tuple>
Link copied to clipboard
external val cursor: Double

The cursor position relative to rl.line.

Link copied to clipboard
Link copied to clipboard
external val line: String

The current input data being processed by node.

Link copied to clipboard
open external val lineEvent: EventInstance<Tuple1<String>>
Link copied to clipboard
open external val pauseEvent: EventInstance<Tuple>
Link copied to clipboard
open external val resumeEvent: EventInstance<Tuple>
Link copied to clipboard
open external val SIGCONTEvent: EventInstance<Tuple>
Link copied to clipboard
open external val SIGINTEvent: EventInstance<Tuple>
Link copied to clipboard
open external val SIGTSTPEvent: EventInstance<Tuple>
Link copied to clipboard
external val terminal: Boolean

Functions

Link copied to clipboard
open external override fun [@@dispose]()
Link copied to clipboard
external fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

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

events.EventEmitter

Link copied to clipboard
external 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.

Link copied to clipboard
external fun emit(type: EventType, vararg args: Any?): Boolean

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

open external fun emit(event: Symbol, vararg args: Any?): Boolean
open external fun emit(event: String, vararg args: Any?): Boolean
Link copied to clipboard

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

Link copied to clipboard
external 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.

Link copied to clipboard
external fun getMaxListeners(): Double

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

Link copied to clipboard
external fun getPrompt(): String

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

Link copied to clipboard
external fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

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.

Link copied to clipboard

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

Link copied to clipboard
external fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

Link copied to clipboard
external fun on(type: EventType, listener: EventListener)

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.

open external fun on(event: String, listener: Function<Unit>)
Link copied to clipboard
external fun once(type: EventType, listener: EventListener)

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

open external fun once(event: String, listener: Function<Unit>)
Link copied to clipboard
external fun pause()

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

Link copied to clipboard
external fun prependListener(type: EventType, listener: EventListener)

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.

open external fun prependListener(event: String, listener: Function<Unit>)
Link copied to clipboard
external fun prependOnceListener(type: EventType, listener: EventListener)

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.

open external fun prependOnceListener(event: String, listener: Function<Unit>)
Link copied to clipboard
external 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.

Link copied to clipboard
external 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.

external fun question(query: String, options: Abortable, callback: (answer: String) -> Unit)
Link copied to clipboard

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

Link copied to clipboard
external fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

Link copied to clipboard
external fun removeListener(type: EventType, listener: EventListener)

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

Link copied to clipboard
external fun resume()

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

Link copied to clipboard
external 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.

Link copied to clipboard
external fun setPrompt(prompt: String)

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

Link copied to clipboard
external fun write(data: String, key: Key = definedExternally)
external 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.

external fun write(data: String?, key: Key)
external fun write(data: Buffer<*>?, key: Key)