clearScreenDown - readline - Node

clearScreenDown - readline - Node documentation

function clearScreenDown

Usage in Deno

import { clearScreenDown } from "node:readline";



clearScreenDown(stream: WritableStream,
callback?: () => void,
): boolean

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

Parameters



stream: WritableStream

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.