readline/promises

Usage in Deno

import * as mod from "node:readline/promises";

class Interface

extends _Interface

Usage in Deno

import { Interface } from "node:readline/promises";

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.

Methods

question(query: string): Promise<string>

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.

When called, rl.question() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the query is not written.

If the question is called after rl.close(), it returns a rejected promise.

Example usage:

const answer = await rl.question('What is your favorite food? ');
console.log(`Oh, so your favorite food is ${answer}`);

Using an AbortSignal to cancel a question.

const signal = AbortSignal.timeout(10_000);

signal.addEventListener('abort', () => {
  console.log('The food question timed out');
}, { once: true });

const answer = await rl.question('What is your favorite food? ', { signal });
console.log(`Oh, so your favorite food is ${answer}`);

question(

query: string,

options: Abortable,
): Promise<string>

class Readline

Usage in Deno

import { Readline } from "node:readline/promises";

Constructors

Readline(

stream: WritableStream,

options?: { autoCommit?: boolean;  },
)

new

Methods

clearLine(dir: Direction): this

The rl.clearLine() method adds to the internal list of pending action an action that clears current line of the associated stream in a specified direction identified by dir. Call rl.commit() to see the effect of this method, unless autoCommit: true was passed to the constructor.

clearScreenDown(): this

The rl.clearScreenDown() method adds to the internal list of pending action an action that clears the associated stream from the current position of the cursor down. Call rl.commit() to see the effect of this method, unless autoCommit: true was passed to the constructor.

commit(): Promise<void>

The rl.commit() method sends all the pending actions to the associated stream and clears the internal list of pending actions.

cursorTo(

x: number,

y?: number,
): this

The rl.cursorTo() method adds to the internal list of pending action an action that moves cursor to the specified position in the associated stream. Call rl.commit() to see the effect of this method, unless autoCommit: true was passed to the constructor.

moveCursor(

dx: number,

dy: number,
): this

The rl.moveCursor() method adds to the internal list of pending action an action that moves the cursor relative to its current position in the associated stream. Call rl.commit() to see the effect of this method, unless autoCommit: true was passed to the constructor.

rollback(): this

The rl.rollback methods clears the internal list of pending actions without sending it to the associated stream.

function createInterface

Usage in Deno

import { createInterface } from "node:readline/promises";

Overload 1

createInterface(

input: ReadableStream,

output?: WritableStream,

completer?: Completer,

terminal?: boolean,
): 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).

Parameters

input: ReadableStream

output: WritableStream

optional

completer: Completer

optional

terminal: boolean

optional

Return Type

Interface

Overload 2

createInterface(options: ReadLineOptions): Interface

Parameters

options: ReadLineOptions

Return Type

Interface

interface ReadLineOptions

extends Omit<_ReadLineOptions, "completer">

Usage in Deno

import { type ReadLineOptions } from "node:readline/promises";

Properties

completer: Completer | undefined

optional

An optional function used for Tab autocompletion.

type alias Completer

Usage in Deno

import { type Completer } from "node:readline/promises";

Definition

(line: string) => CompleterResult | Promise<CompleterResult>