Skip to content

Promises

[<Interface>]
type Promises =
    abstract member Interface: InterfaceConstructor with get, set
    abstract member Readline: ReadlineConstructor with get, set
    abstract member createInterface (options: ReadLineOptions) : Interface
    abstract member createInterface (input: ReadableStream, ?output: WritableStream, ?completer: Completer, ?terminal: bool) : Interface
AssemblyXantham.Fable.Node

node:readline/promises

Declared inside

Completer
ExportsThe package's value exports, each bound to its import
InterfaceInstances of the readlinePromises.Interface class are constructed using the readlinePromises.createInterface() method
ReadLineOptions
Readline

Properties

abstract member Interface: InterfaceConstructor with get, set

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

abstract member Readline: ReadlineConstructor with get, set

@since v17.0.0

Methods

abstract member createInterface (options: ReadLineOptions) : Interface

The readlinePromises.createInterface() method creates a new readlinePromises.Interface instance.

import readlinePromises from 'node:readline/promises';
const rl = readlinePromises.createInterface({
input: process.stdin,
output: process.stdout,
});

Once the readlinePromises.Interface instance is created, the most common case is to listen for the 'line' event:

rl.on('line', (line) => {
console.log(`Received: ${line}`);
});

If terminal is true for this instance then the output stream will get the best compatibility if it defines an output.columns property and emits a 'resize' event on the output if or when the columns ever change (process.stdout does this automatically when it is a TTY).

@since v17.0.0

abstract member createInterface (input: ReadableStream, ?output: WritableStream, ?completer: Completer, ?terminal: bool) : Interface

The readlinePromises.createInterface() method creates a new readlinePromises.Interface instance.

import readlinePromises from 'node:readline/promises';
const rl = readlinePromises.createInterface({
input: process.stdin,
output: process.stdout,
});

Once the readlinePromises.Interface instance is created, the most common case is to listen for the 'line' event:

rl.on('line', (line) => {
console.log(`Received: ${line}`);
});

If terminal is true for this instance then the output stream will get the best compatibility if it defines an output.columns property and emits a 'resize' event on the output if or when the columns ever change (process.stdout does this automatically when it is a TTY).

@since v17.0.0