cursorTo - readline - Node

cursorTo - readline - Node documentation

function cursorTo

Usage in Deno

import { cursorTo } from "node:readline";



cursorTo(stream: WritableStream,
x: number,
y?: number,
callback?: () => void,
): boolean

The readline.cursorTo() method moves cursor to the specified position in a given TTY stream.

Parameters



stream: WritableStream



x: number

optional



y: number

optional



callback: () => void

Invoked once the operation completes.

Return Type

boolean

false if stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.