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.

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 description for the listener argument #28500

Closed
wants to merge 1 commit into from

Conversation

lpinca
Copy link
Member

@lpinca lpinca commented Jul 1, 2019

Clarify that listener is registered as a one-time listener of the
'connect' event.

Fixes: #28217

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Jul 1, 2019
doc/api/http2.md Outdated
@@ -2208,7 +2208,8 @@ changes:
instance passed to `connect` and the `options` object, and returns any
[`Duplex`][] stream that is to be used as the connection for this session.
* ...: Any [`net.connect()`][] or [`tls.connect()`][] options can be provided.
* `listener` {Function}
* `listener` {Function} Will be added as a one-time listener of the
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this makes it even a bit clearer?

Suggested change
* `listener` {Function} Will be added as a one-time listener of the
* `listener` {Function} Will be registered as a one-time listener of the

Clarify that `listener` is registered as a one-time listener of the
`'connect'` event.

Fixes: nodejs#28217
@lpinca
Copy link
Member Author

lpinca commented Jul 6, 2019

Landed in 8850ef2.

@lpinca lpinca closed this Jul 6, 2019
@lpinca lpinca deleted the gh-28217 branch July 6, 2019 09:07
lpinca added a commit that referenced this pull request Jul 6, 2019
Clarify that `listener` is registered as a one-time listener of the
`'connect'` event.

PR-URL: #28500
Fixes: #28217
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
targos pushed a commit that referenced this pull request Jul 20, 2019
Clarify that `listener` is registered as a one-time listener of the
`'connect'` event.

PR-URL: #28500
Fixes: #28217
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
This was referenced Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

http2.connect's listener Parameter is Not Explained in The Documentation
6 participants