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: simplify http2 wording and formatting #22541

Closed
wants to merge 1 commit into from
Closed

doc: simplify http2 wording and formatting #22541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,10 +752,10 @@ is emitted immediately after queuing the last chunk of payload data to be sent.
The `http2stream.sendTrailers()` method can then be called to send trailing
headers to the peer.

It is important to note that when `options.waitForTrailers` is set, the
`Http2Stream` will *not* automatically close when the final `DATA` frame is
transmitted. User code *must* call either `http2stream.sendTrailers()` or
`http2stream.close()` to close the `Http2Stream`.
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
close when the final `DATA` frame is transmitted. User code must call either
`http2stream.sendTrailers()` or `http2stream.close()` to close the
`Http2Stream`.

The `:method` and `:path` pseudo-headers are not specified within `headers`,
they respectively default to:
Expand Down Expand Up @@ -1291,10 +1291,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
header fields to the peer.

It is important to note that when `options.waitForTrailers` is set, the
`Http2Stream` will *not* automatically close when the final `DATA` frame is
transmitted. User code *must* call either `http2stream.sendTrailers()` or
`http2stream.close()` to close the `Http2Stream`.
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
close when the final `DATA` frame is transmitted. User code must call either
`http2stream.sendTrailers()` or `http2stream.close()` to close the
`Http2Stream`.

```js
const http2 = require('http2');
Expand Down Expand Up @@ -1375,10 +1375,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
sent. The `http2stream.sendTrailers()` method can then be used to sent trailing
header fields to the peer.

It is important to note that when `options.waitForTrailers` is set, the
`Http2Stream` will *not* automatically close when the final `DATA` frame is
transmitted. User code *must* call either `http2stream.sendTrailers()` or
`http2stream.close()` to close the `Http2Stream`.
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
close when the final `DATA` frame is transmitted. User code *must* call either
`http2stream.sendTrailers()` or `http2stream.close()` to close the
`Http2Stream`.

```js
const http2 = require('http2');
Expand Down Expand Up @@ -1499,10 +1499,10 @@ will be emitted immediately after queuing the last chunk of payload data to be
sent. The `http2stream.sendTrilers()` method can then be used to sent trailing
header fields to the peer.

It is important to note that when `options.waitForTrailers` is set, the
`Http2Stream` will *not* automatically close when the final `DATA` frame is
transmitted. User code *must* call either `http2stream.sendTrailers()` or
`http2stream.close()` to close the `Http2Stream`.
When `options.waitForTrailers` is set, the `Http2Stream` will not automatically
close when the final `DATA` frame is transmitted. User code must call either
`http2stream.sendTrailers()` or `http2stream.close()` to close the
`Http2Stream`.

```js
const http2 = require('http2');
Expand Down