Skip to content

Commit 43ac36c

Browse files
TrottMylesBorins
authored andcommitted
doc: grammar fixes in http2.md
Backport-PR-URL: #18050 PR-URL: #17972 Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent 6839283 commit 43ac36c

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

doc/api/http2.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ When invoked, the handler function will receive three arguments:
166166

167167
If the `'frameError'` event is associated with a stream, the stream will be
168168
closed and destroyed immediately following the `'frameError'` event. If the
169-
event is not associated with a stream, the `Http2Session` will be shutdown
169+
event is not associated with a stream, the `Http2Session` will be shut down
170170
immediately following the `'frameError'` event.
171171

172172
#### Event: 'goaway'
@@ -183,7 +183,7 @@ the handler function will receive three arguments:
183183
* `opaqueData` {Buffer} If additional opaque data was included in the GOAWAY
184184
frame, a `Buffer` instance will be passed containing that data.
185185

186-
*Note*: The `Http2Session` instance will be shutdown automatically when the
186+
*Note*: The `Http2Session` instance will be shut down automatically when the
187187
`'goaway'` event is emitted.
188188

189189
#### Event: 'localSettings'
@@ -499,7 +499,7 @@ added: v8.4.0
499499
has been completed.
500500
* Returns: {undefined}
501501

502-
Attempts to shutdown this `Http2Session` using HTTP/2 defined procedures.
502+
Attempts to shut down this `Http2Session` using HTTP/2 defined procedures.
503503
If specified, the given `callback` function will be invoked once the shutdown
504504
process has completed.
505505

@@ -635,7 +635,7 @@ may be passed to clear any previously set alternative service for a given
635635
domain.
636636

637637
When a string is passed for the `originOrStream` argument, it will be parsed as
638-
a URL and the origin will be derived. For insetance, the origin for the
638+
a URL and the origin will be derived. For instance, the origin for the
639639
HTTP URL `'https://example.org/foo/bar'` is the ASCII string
640640
`'https://example.org'`. An error will be thrown if either the given string
641641
cannot be parsed as a URL or if a valid origin cannot be derived.
@@ -739,15 +739,15 @@ req.on('response', (headers) => {
739739

740740
When set, the `options.getTrailers()` function is called immediately after
741741
queuing the last chunk of payload data to be sent. The callback is passed a
742-
single object (with a `null` prototype) that the listener may used to specify
742+
single object (with a `null` prototype) that the listener may use to specify
743743
the trailing header fields to send to the peer.
744744

745745
*Note*: The HTTP/1 specification forbids trailers from containing HTTP/2
746-
"pseudo-header" fields (e.g. `':method'`, `':path'`, etc). An `'error'` event
746+
pseudo-header fields (e.g. `':method'`, `':path'`, etc). An `'error'` event
747747
will be emitted if the `getTrailers` callback attempts to set such header
748748
fields.
749749

750-
The `:method` and `:path` pseudoheaders are not specified within `headers`,
750+
The `:method` and `:path` pseudo-headers are not specified within `headers`,
751751
they respectively default to:
752752

753753
* `:method` = `'GET'`
@@ -774,7 +774,7 @@ On the client, `Http2Stream` instances are created and returned when either the
774774
`'push'` event.
775775

776776
*Note*: The `Http2Stream` class is a base for the [`ServerHttp2Stream`][] and
777-
[`ClientHttp2Stream`][] classes, each of which are used specifically by either
777+
[`ClientHttp2Stream`][] classes, each of which is used specifically by either
778778
the Server or Client side, respectively.
779779

780780
All `Http2Stream` instances are [`Duplex`][] streams. The `Writable` side of the
@@ -798,7 +798,7 @@ On the client side, instances of [`ClientHttp2Stream`][] are created when the
798798
`http2session.request()` may not be immediately ready for use if the parent
799799
`Http2Session` has not yet been fully established. In such cases, operations
800800
called on the `Http2Stream` will be buffered until the `'ready'` event is
801-
emitted. User code should rarely, if ever, have need to handle the `'ready'`
801+
emitted. User code should rarely, if ever, need to handle the `'ready'`
802802
event directly. The ready status of an `Http2Stream` can be determined by
803803
checking the value of `http2stream.id`. If the value is `undefined`, the stream
804804
is not yet ready for use.
@@ -1048,7 +1048,7 @@ added: v8.4.0
10481048
-->
10491049

10501050
The `'headers'` event is emitted when an additional block of headers is received
1051-
for a stream, such as when a block of `1xx` informational headers are received.
1051+
for a stream, such as when a block of `1xx` informational headers is received.
10521052
The listener callback is passed the [Headers Object][] and flags associated with
10531053
the headers.
10541054

@@ -1198,7 +1198,7 @@ server.on('stream', (stream) => {
11981198

11991199
When set, the `options.getTrailers()` function is called immediately after
12001200
queuing the last chunk of payload data to be sent. The callback is passed a
1201-
single object (with a `null` prototype) that the listener may used to specify
1201+
single object (with a `null` prototype) that the listener may use to specify
12021202
the trailing header fields to send to the peer.
12031203

12041204
```js
@@ -1215,7 +1215,7 @@ server.on('stream', (stream) => {
12151215
```
12161216

12171217
*Note*: The HTTP/1 specification forbids trailers from containing HTTP/2
1218-
"pseudo-header" fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
1218+
pseudo-header fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
12191219
will be emitted if the `getTrailers` callback attempts to set such header
12201220
fields.
12211221

@@ -1272,7 +1272,7 @@ requests.
12721272

12731273
When set, the `options.getTrailers()` function is called immediately after
12741274
queuing the last chunk of payload data to be sent. The callback is passed a
1275-
single object (with a `null` prototype) that the listener may used to specify
1275+
single object (with a `null` prototype) that the listener may use to specify
12761276
the trailing header fields to send to the peer.
12771277

12781278
```js
@@ -1299,7 +1299,7 @@ server.on('close', () => fs.closeSync(fd));
12991299
```
13001300

13011301
*Note*: The HTTP/1 specification forbids trailers from containing HTTP/2
1302-
"pseudo-header" fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
1302+
pseudo-header fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
13031303
will be emitted if the `getTrailers` callback attempts to set such header
13041304
fields.
13051305

@@ -1331,7 +1331,7 @@ of the given file:
13311331

13321332
If an error occurs while attempting to read the file data, the `Http2Stream`
13331333
will be closed using an `RST_STREAM` frame using the standard `INTERNAL_ERROR`
1334-
code. If the `onError` callback is defined it will be called, otherwise
1334+
code. If the `onError` callback is defined, then it will be called. Otherwise
13351335
the stream will be destroyed.
13361336

13371337
Example using a file path:
@@ -1391,7 +1391,7 @@ default behavior is to destroy the stream.
13911391

13921392
When set, the `options.getTrailers()` function is called immediately after
13931393
queuing the last chunk of payload data to be sent. The callback is passed a
1394-
single object (with a `null` prototype) that the listener may used to specify
1394+
single object (with a `null` prototype) that the listener may use to specify
13951395
the trailing header fields to send to the peer.
13961396

13971397
```js
@@ -1408,7 +1408,7 @@ server.on('stream', (stream) => {
14081408
```
14091409

14101410
*Note*: The HTTP/1 specification forbids trailers from containing HTTP/2
1411-
"pseudo-header" fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
1411+
pseudo-header fields (e.g. `':status'`, `':path'`, etc). An `'error'` event
14121412
will be emitted if the `getTrailers` callback attempts to set such header
14131413
fields.
14141414

@@ -1478,7 +1478,7 @@ an `Http2Session` object associated with the `Http2Server`.
14781478
added: v8.5.0
14791479
-->
14801480

1481-
If an `ServerHttp2Stream` emits an `'error'` event, it will be forwarded here.
1481+
If a `ServerHttp2Stream` emits an `'error'` event, it will be forwarded here.
14821482
The stream will already be destroyed when this event is triggered.
14831483

14841484
#### Event: 'stream'
@@ -1664,7 +1664,7 @@ changes:
16641664
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
16651665
enough padding to ensure that the total frame length, including the
16661666
9-byte header, is a multiple of 8. For each frame, however, there is a
1667-
maxmimum allowed number of padding bytes that is determined by current
1667+
maximum allowed number of padding bytes that is determined by current
16681668
flow control state and settings. If this maximum is less than the
16691669
calculated amount needed to ensure alignment, the maximum will be used
16701670
and the total frame length will *not* necessarily be aligned at 8 bytes.
@@ -1751,7 +1751,7 @@ changes:
17511751
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
17521752
enough padding to ensure that the total frame length, including the
17531753
9-byte header, is a multiple of 8. For each frame, however, there is a
1754-
maxmimum allowed number of padding bytes that is determined by current
1754+
maximum allowed number of padding bytes that is determined by current
17551755
flow control state and settings. If this maximum is less than the
17561756
calculated amount needed to ensure alignment, the maximum will be used
17571757
and the total frame length will *not* necessarily be aligned at 8 bytes.
@@ -1847,7 +1847,7 @@ changes:
18471847
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
18481848
enough padding to ensure that the total frame length, including the
18491849
9-byte header, is a multiple of 8. For each frame, however, there is a
1850-
maxmimum allowed number of padding bytes that is determined by current
1850+
maximum allowed number of padding bytes that is determined by current
18511851
flow control state and settings. If this maximum is less than the
18521852
calculated amount needed to ensure alignment, the maximum will be used
18531853
and the total frame length will *not* necessarily be aligned at 8 bytes.
@@ -2189,8 +2189,8 @@ req.end('Jane');
21892189

21902190
The Compatibility API has the goal of providing a similar developer experience
21912191
of HTTP/1 when using HTTP/2, making it possible to develop applications
2192-
that supports both [HTTP/1][] and HTTP/2. This API targets only the
2193-
**public API** of the [HTTP/1][], however many modules uses internal
2192+
that support both [HTTP/1][] and HTTP/2. This API targets only the
2193+
**public API** of the [HTTP/1][]. However many modules use internal
21942194
methods or state, and those _are not supported_ as it is a completely
21952195
different implementation.
21962196

@@ -2218,7 +2218,7 @@ the status message for HTTP codes is ignored.
22182218

22192219
### ALPN negotiation
22202220

2221-
ALPN negotiation allows to support both [HTTPS][] and HTTP/2 over
2221+
ALPN negotiation allows supporting both [HTTPS][] and HTTP/2 over
22222222
the same socket. The `req` and `res` objects can be either HTTP/1 or
22232223
HTTP/2, and an application **must** restrict itself to the public API of
22242224
[HTTP/1][], and detect if it is possible to use the more advanced
@@ -2260,7 +2260,7 @@ added: v8.4.0
22602260

22612261
A `Http2ServerRequest` object is created by [`http2.Server`][] or
22622262
[`http2.SecureServer`][] and passed as the first argument to the
2263-
[`'request'`][] event. It may be used to access a request status, headers and
2263+
[`'request'`][] event. It may be used to access a request status, headers, and
22642264
data.
22652265

22662266
It implements the [Readable Stream][] interface, as well as the
@@ -2321,7 +2321,7 @@ console.log(request.headers);
23212321

23222322
See [Headers Object][].
23232323

2324-
*Note*: In HTTP/2, the request path, host name, protocol, and method are
2324+
*Note*: In HTTP/2, the request path, hostname, protocol, and method are
23252325
represented as special headers prefixed with the `:` character (e.g. `':path'`).
23262326
These special headers will be included in the `request.headers` object. Care
23272327
must be taken not to inadvertently modify these special headers or errors may
@@ -2354,7 +2354,7 @@ added: v8.4.0
23542354

23552355
* {string}
23562356

2357-
The request method as a string. Read only. Example:
2357+
The request method as a string. Read-only. Example:
23582358
`'GET'`, `'DELETE'`.
23592359

23602360
#### request.rawHeaders
@@ -3012,7 +3012,7 @@ If `name` is equal to `Http2Session`, the `PerformanceEntry` will contain the
30123012
following additional properties:
30133013

30143014
* `pingRTT` {number} The number of milliseconds elapsed since the transmission
3015-
of a `PING` frame and the reception of its acknowledgement. Only present if
3015+
of a `PING` frame and the reception of its acknowledgment. Only present if
30163016
a `PING` frame has been sent on the `Http2Session`.
30173017
* `streamCount` {number} The number of `Http2Stream` instances processed by
30183018
the `Http2Session`.

0 commit comments

Comments
 (0)