Skip to main content

cursorTo

function cursorTo
Jump to headingcursorTo(
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 Jump to heading

Jump to headingstream: WritableStream
optional
Jump to headingy: number
optional
Jump to headingcallback: () => void

Invoked once the operation completes.

Return Type Jump to heading

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.

Back to top