promises.Readline - readline - Node

class promises.Readline

Usage in Deno

import { promises } from "node:readline";

Constructors

new



Readline(stream: WritableStream,
options?: { autoCommit?: boolean;  },
)

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.