Interface

external class Interface : _Interface(source)

Instances of the readlinePromises.Interface class are constructed using the readlinePromises.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

v17.0.0

Constructors

Interface

constructor()

Properties

cursor

val cursor: Double

The cursor position relative to rl.line.

line

val line: String

The current input data being processed by node.

terminal

val terminal: Boolean

Functions

addListener

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

events.EventEmitter

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 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.

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

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

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

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

fun emit(event: InterfaceEvent.LINE, input: String): 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().

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

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)

once

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

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)

pause

fun pause()

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

prependListener

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

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)

prependOnceListener

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

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)

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

suspend fun question(query: String): String

suspend fun question(query: String, options: Abortable): String

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

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.

questionAsync

fun questionAsync(query: String): Promise<String>

fun questionAsync(query: String, options: Abortable): Promise<String>

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.

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)