Skip to main content

clearScreenDown

function clearScreenDown
Jump to headingclearScreenDown(
stream: WritableStream,
callback?: () => void,
): boolean

The readline.clearScreenDown() method clears the given TTY stream from the current position of the cursor down.

Parameters Jump to heading

Jump to headingstream: WritableStream
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