Skip to main content

clearScreenDown

method WriteStream.prototype.clearScreenDown
Jump to headingWriteStream.prototype.clearScreenDown(callback?: () => void): boolean

writeStream.clearScreenDown() clears this WriteStream from the current cursor down.

Parameters Jump to heading

optional
Jump to headingcallback: () => void

Invoked once the operation completes.

Return Type Jump to heading

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.

Back to top