doc: note 'resize' event conditions on Windows

PR-URL: #13576 Fixes: #13197 Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Bartosz Sosnowski <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
nodejs · Jul 18, 2017 · cfa5e0c · cfa5e0c
1 parent e080fb3
commit cfa5e0c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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