diff options
| author | Dean Coakley <dean.s.coakley@gmail.com> | 2017-06-09 16:40:53 +0300 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-07-10 00:59:11 +0300 |
| commit | ff07eaa140e54745a5298f4c929936cfe055ed3c (patch) | |
| tree | 9ea78316b4dfaecfb83edd95686a687b422416cf /doc/api/tty.md | |
| parent | 1b2733f272b77fb2beaa4b1f5ee600e8b9c36e14 (diff) | |
doc: note 'resize' event conditions on Windows
PR-URL: https://github.com/nodejs/node/pull/13576
Fixes: https://github.com/nodejs/node/issues/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>
Diffstat (limited to 'doc/api/tty.md')
| -rw-r--r-- | doc/api/tty.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md index 8f250e45d65..963de892cbc 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -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 |