Node Reference for WriteStream.prototype.cursorTo

method WriteStream.prototype.cursorTo

Usage in Deno

import { WriteStream } from "node:tty";



WriteStream.prototype.cursorTo(x: number,
y?: number,
callback?: () => void,
): boolean

writeStream.cursorTo() moves this WriteStream's cursor to the specified position.

Parameters



x: number

optional



y: number

optional



callback: () => void

Invoked once the operation completes.

Return Type

boolean

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



WriteStream.prototype.cursorTo(x: number,
callback: () => void,
): boolean

Parameters



x: number



callback: () => void

Return Type

boolean