Permalink
Browse files

doc: note 'resize' event conditions on Windows

PR-URL: #13576
Fixes: #13197
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
  • Loading branch information...
Dean-Coakley authored and refack committed Jun 9, 2017
1 parent 1b2733f commit ff07eaa140e54745a5298f4c929936cfe055ed3c
Showing with 9 additions and 0 deletions.
  1. +9 −0 doc/api/tty.md
View
@@ -88,6 +88,15 @@ process.stdout.on('resize', () => {
});
```
*Note*: On Windows resize events will be emitted only if stdin is unpaused
(by a call to `resume()` or by adding a data listener) and in raw mode. It can
also be triggered if a terminal control sequence that moves the cursor is
written to the screen. Also, the resize event will only be signaled if the
console screen buffer height was also changed. For example shrinking the
console window height will not cause the resize event to be emitted. Increasing
the console window height will only be registered when the new console window
height is greater than the current console buffer size.
### writeStream.columns
<!-- YAML
added: v0.7.7

0 comments on commit ff07eaa

Please sign in to comment.