1.0.0 • Published 7 years ago

cross-clear v1.0.0

Weekly downloads
57
License
WTFPL
Repository
github
Last release
7 years ago

cross-clear

Modern cross-platform terminal screen clearing.

This module uses Node's official readline API so it works reliably in all terminals on all platforms. The used functions (readline.cursorTo and readline.clearScreenDown) are available since Node v0.12.0.

Installation

npm install cross-clear

Quickstart

const clear = require('cross-clear')

clear() // clears stdout
clear(process.stderr) // clears stderr

API

clear([stream])

  • Clears the given stream; if no stream is provided, process.stdout will be cleared
  • Gracefully does nothing if not run in a text terminal (stream.isTTY) or if the provided stream is not writable (stream.writable)

CLI

$ cross-clear

License

WTFPL – Do What the F*ck You Want to Public License.

Made with :heart: by @MarkTiedemann.