Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add note to tty.WriteStream event 'resize' on Windows #13576

Closed
wants to merge 9 commits into from
Closed

doc: add note to tty.WriteStream event 'resize' on Windows #13576

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6da59fe
doc: note 'resize' event unreliability on Windows
Dean-Coakley Jun 9, 2017
a45bd1d
doc: correct 'resize' event note
Dean-Coakley Jun 9, 2017
84db75d
doc: add more detail on note
Dean-Coakley Jun 15, 2017
63fa375
doc: correct char limit
Dean-Coakley Jun 15, 2017
86dfd24
doc: add more detail on note
Dean-Coakley Jul 7, 2017
192a56f
doc: fix details on note
Dean-Coakley Jul 7, 2017
784055f
doc: fix err on resume note
Dean-Coakley Jul 7, 2017
05ce78a
doc: remove backslash
Dean-Coakley Jul 7, 2017
5944bf0
doc: merge note paragraphs
Dean-Coakley Jul 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/tty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ process.stdout.on('resize', () => {
});
```

*Note:* On Windows resize events will be emitted only if stdin is unpaused
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny nit: *Note:* -> *Note*:

Copy link
Contributor Author

@Dean-Coakley Dean-Coakley Jul 8, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm...I copied this mistake from async_notes.md Should that be fixed in a separate PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep.
Ref: #13133

(by a call to \resume()`` or by adding a data listener) and in raw mode. It can
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've changed to \resume()'', you need to have `resume()`

also be triggered if a terminal control sequence that moves the cursor is written
to the screen.

*Note:* On Windows when changing console height the resize event will be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. *Note:* -> *Note*:
  2. IMHO the two paragraphs could be merged:
    Also, the resize event will be signaled only if the console screen buffer height was also changed...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Sorry, but I'm not entirely sure what you want here.

Can you paste the body of text you'd like? Or be very verbose about what should be replaced.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

*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.
  1. Check that it is still true (the word also implies both conditions need to be met)
  2. See if you like it. This one is just a suggestion.

signaled only 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
Expand Down