diff options
author | Dean Coakley <dean.s.coakley@gmail.com> | 2017-06-09 09:40:53 -0400 |
---|---|---|
committer | Myles Borins <mylesborins@google.com> | 2017-09-05 12:49:52 -0400 |
commit | 9599faae187a9aaa25e3611033b2e96cdda3e36a (patch) | |
tree | ce7bb92d582ef2cb8a60d947cc06931e6b0b394b | |
parent | 8dbf827de36b565231583d3725178bf00e355baf (diff) | |
download | node-new-9599faae187a9aaa25e3611033b2e96cdda3e36a.tar.gz |
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>
-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 8f250e45d6..963de892cb 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 |