Browse Source

doc refactor: tty

v0.9.1-release
isaacs 13 years ago
parent
commit
cf4700aff4
  1. 10
      doc/api/tty.markdown

10
doc/api/tty.markdown

@ -1,4 +1,4 @@
## TTY # TTY
Use `require('tty')` to access this module. Use `require('tty')` to access this module.
@ -16,23 +16,23 @@ Example:
### tty.isatty(fd) ## tty.isatty(fd)
Returns `true` or `false` depending on if the `fd` is associated with a Returns `true` or `false` depending on if the `fd` is associated with a
terminal. terminal.
### tty.setRawMode(mode) ## tty.setRawMode(mode)
`mode` should be `true` or `false`. This sets the properties of the current `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. process's stdin fd to act either as a raw device or default.
### tty.setWindowSize(fd, row, col) ## tty.setWindowSize(fd, row, col)
This function was removed in v0.6.0. This function was removed in v0.6.0.
### tty.getWindowSize(fd) ## tty.getWindowSize(fd)
This function was removed in v0.6.0. Use `process.stdout.getWindowSize()` This function was removed in v0.6.0. Use `process.stdout.getWindowSize()`
instead. instead.

Loading…
Cancel
Save