Operations for managing terminal display, clearing screens, controlling screen buffers, scrolling, and audio feedback.
Clear the terminal screen and manage display state.
/**
* Clear the terminal screen (viewport only)
*/
const clearScreen: string;
/**
* Clear the whole terminal, including scrollback buffer
*/
const clearTerminal: string;
/**
* Erase the screen and move cursor to top-left position
*/
const eraseScreen: string;Usage Examples:
import { clearScreen, clearTerminal, eraseScreen } from 'ansi-escapes';
// Clear visible terminal screen
process.stdout.write(clearScreen);
// Clear terminal including scrollback history
process.stdout.write(clearTerminal);
// Erase screen and reset cursor position
process.stdout.write(eraseScreen);Control alternative screen buffer for full-screen applications.
/**
* Enter the alternative screen buffer
*/
const enterAlternativeScreen: string;
/**
* Exit the alternative screen buffer, returning to main screen
*/
const exitAlternativeScreen: string;Usage Examples:
import { enterAlternativeScreen, exitAlternativeScreen } from 'ansi-escapes';
// Enter alternative screen (like vim, less, etc.)
process.stdout.write(enterAlternativeScreen);
// ... run full-screen application ...
// Return to main screen, restoring previous content
process.stdout.write(exitAlternativeScreen);The alternative screen buffer allows applications to use the full terminal without affecting the user's existing terminal content. When the application exits the alternative screen, the previous content is restored.
Control terminal scrolling behavior.
/**
* Scroll display up one line
*/
const scrollUp: string;
/**
* Scroll display down one line
*/
const scrollDown: string;Usage Examples:
import { scrollUp, scrollDown } from 'ansi-escapes';
// Scroll terminal content up by one line
process.stdout.write(scrollUp);
// Scroll terminal content down by one line
process.stdout.write(scrollDown);Generate audio signals from the terminal.
/**
* Output a beeping sound
*/
const beep: string;Usage Examples:
import { beep } from 'ansi-escapes';
// Generate a system beep
process.stdout.write(beep);
// Use for alerts or notifications
if (errorOccurred) {
process.stdout.write(beep);
console.log('Error: Operation failed!');
}The screen management operations handle cross-platform differences automatically:
Cross-platform clearing example:
import { clearTerminal } from 'ansi-escapes';
// This works consistently across Windows, macOS, and Linux
function clearAndReset() {
process.stdout.write(clearTerminal);
console.log('Terminal cleared successfully!');
}