-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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 parameters for Http2Session:stream event #20547
Conversation
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment)
Also, please respond with 👍 to approve fast-tracking. |
doc/api/http2.md
Outdated
* `stream` {Http2Stream} A reference to the stream | ||
* `headers` {HTTP/2 Headers Object} An object describing the headers | ||
* `flags` {number} The associated numeric flags | ||
* `rawHeaders` {Array} An array containing the raw header name value pairs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this actually supposed to be public? @nodejs/http2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure what is the convention here, but maybe name value
-> name-value
or name/value
or name:value
(with or without spaces, I am not sure as well)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it's correct. rawHeaders
is exposed as request.rawHeaders
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vsemozhetbyt I think it could be either depending on the key:value
delimiter? Let me check what the delimiter is in this particular case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM but have a question about rawHeaders
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
P.S. Checked it out by running an actual example, and the strings weren't |
@vsemozhetbyt take another look? |
LGTM. |
CI passed, landing this. |
BTW, @vsemozhetbyt I wanted to talk to you about a thing or two regarding docs, but couldn't find you on IRC. How can I reach out to you? |
Landed in 29ccf6e |
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@ryzokuken I do not monitor IRC, but the email in the GitHub profile is live) |
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: #20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: #20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: #20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) Backport-PR-URL: #22850 PR-URL: #20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Add parameters for the callback for the Http2Session:stream event
inline with the pattern in the rest of the documentation.
Refs: nodejs/help#877 (comment)
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesP.S. I was kinda confused regarding the type of the
flags
variable, so I set it toNumber
for now./cc @nodejs/http2 @mcollina @vsemozhetbyt