• Index
• TOC

TTY

Use require('tty') to access this module.

Example:

var tty = require('tty');
process.stdin.resume();
tty.setRawMode(true);
process.stdin.on('keypress', function(char, key) {
  if (key && key.ctrl && key.name == 'c') {
    console.log('graceful exit');
    process.exit()
  }
});

Table of Contents #

• tty.isatty()
• tty.setRawMode()
• tty.setWindowSize()
• tty.getWindowSize()

tty.isatty(fd) #

Returns true or false depending on if the fd is associated with a terminal.

tty.setRawMode(mode) #

mode should be true or false. This sets the properties of the current process's stdin fd to act either as a raw device or default.

tty.setWindowSize(fd, row, col) #

This function was removed in v0.6.0.

tty.getWindowSize(fd) #

This function was removed in v0.6.0. Use process.stdout.getWindowSize() instead.

---

Documentation generated by mdoc.