Skip to content

Commit 648696b

Browse files
Ayase-252benjamingr
authored andcommitted
doc: fix grammar errors in http document
PR-URL: #37265 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
1 parent 53b673e commit 648696b

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

doc/api/http.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2256,7 +2256,7 @@ Emitted when the buffer of the message is free again.
22562256
added: v0.1.17
22572257
-->
22582258

2259-
Emitted when transmission is finished successfully.
2259+
Emitted when the transmission is finished successfully.
22602260

22612261
### Event: `prefinish`
22622262
<!-- YAML
@@ -2277,9 +2277,9 @@ added: v0.3.0
22772277
Adds HTTP trailers (headers but at the end of the message) to the message.
22782278

22792279
Trailers are **only** be emitted if the message is chunked encoded. If not,
2280-
trailer will be silently discarded.
2280+
the trailer will be silently discarded.
22812281

2282-
HTTP requires the `Trailer` header to be sent in order to emit trailers,
2282+
HTTP requires the `Trailer` header to be sent to emit trailers,
22832283
with a list of header fields in its value, e.g.
22842284

22852285
```js
@@ -2368,8 +2368,8 @@ added: v0.4.0
23682368
* `name` {string} Name of header
23692369
* Returns {string | undefined}
23702370

2371-
Gets value of HTTP header with given name. If such name doesn't exist in
2372-
message, it will be `undefined`.
2371+
Gets the value of HTTP header with the given name. If such a name doesn't
2372+
exist in message, it will be `undefined`.
23732373

23742374
### `outgoingMessage.getHeaderNames()`
23752375
<!-- YAML
@@ -2390,7 +2390,7 @@ added: v8.0.0
23902390

23912391
Returns a shallow copy of the current outgoing headers. Since a shallow
23922392
copy is used, array values may be mutated without additional calls to
2393-
various header-related http module methods. The keys of the returned
2393+
various header-related HTTP module methods. The keys of the returned
23942394
object are the header names and the values are the respective header
23952395
values. All header names are lowercase.
23962396

@@ -2443,7 +2443,7 @@ Since `OutgoingMessage` should be a write-only stream,
24432443
call this function will throw an `Error`. Thus, it disabled the pipe method
24442444
it inherits from `Stream`.
24452445

2446-
User should not call this function directly.
2446+
The User should not call this function directly.
24472447

24482448
### `outgoingMessage.removeHeader()`
24492449
<!-- YAML
@@ -2465,7 +2465,7 @@ added: v0.4.0
24652465
* `value` {string} Header value
24662466
* Returns: {this}
24672467

2468-
Sets a single header value for header object.
2468+
Sets a single header value for the header object.
24692469

24702470
### `outgoingMessage.setTimeout(msesc[, callback])`
24712471
<!-- YAML
@@ -2487,7 +2487,7 @@ added: v0.3.0
24872487

24882488
* {stream.Duplex}
24892489

2490-
Reference to the underlying socket. Usually users will not want to access
2490+
Reference to the underlying socket. Usually, users will not want to access
24912491
this property.
24922492

24932493
After calling `outgoingMessage.end()`, this property will be nulled.
@@ -2540,8 +2540,8 @@ This `outgoingMessage.writableHighWaterMark` will be the `highWaterMark` of
25402540
underlying socket if socket exists. Else, it would be the default
25412541
`highWaterMark`.
25422542

2543-
`highWaterMark` is the maximum amount of data which can be potentially
2544-
buffered by socket.
2543+
`highWaterMark` is the maximum amount of data that can be potentially
2544+
buffered by the socket.
25452545

25462546
### `outgoingMessage.writableLength`
25472547
<!-- YAML
@@ -2575,11 +2575,11 @@ changes:
25752575
* `callback` {Function}
25762576
* Returns {boolean}
25772577

2578-
If this method is called and header is not sent, it will call
2578+
If this method is called and the header is not sent, it will call
25792579
`this._implicitHeader` to flush implicit header.
25802580
If the message should not have a body (indicated by `this._hasBody`),
25812581
the call is ignored and `chunk` will not be sent. It could be useful
2582-
when handling particular message which must not include a body.
2582+
when handling a particular message which must not include a body.
25832583
e.g. response to `HEAD` request, `204` and `304` response.
25842584

25852585
`chunk` can be a string or a buffer. When `chunk` is a string, the
@@ -2588,21 +2588,21 @@ e.g. response to `HEAD` request, `204` and `304` response.
25882588

25892589
If the message is transferred in chucked encoding
25902590
(indicated by `this.chunkedEncoding`), `chunk` will be flushed as
2591-
one chunk among a stream of chunks. Otherwise, it will be flushed as body
2592-
of message.
2591+
one chunk among a stream of chunks. Otherwise, it will be flushed as the
2592+
body of message.
25932593

2594-
This method handles the raw body of HTTP message and has nothing to do with
2595-
higher-level multi-part body encodings that may be used.
2594+
This method handles the raw body of the HTTP message and has nothing to do
2595+
with higher-level multi-part body encodings that may be used.
25962596

25972597
If it is the first call to this method of a message, it will send the
25982598
buffered header first, then flush the the `chunk` as described above.
25992599

2600-
The second and successive calls to this method, it will assume the data
2601-
will streamed and send the new data separately. It means that the response
2600+
The second and successive calls to this method will assume the data
2601+
will be streamed and send the new data separately. It means that the response
26022602
is buffered up to the first chunk of the body.
26032603

26042604
Returns `true` if the entire data was flushed successfully to the kernel
2605-
buffer. Returns `false` if all or part of the data was queued in user
2605+
buffer. Returns `false` if all or part of the data was queued in the user
26062606
memory. Event `drain` will be emitted when the buffer is free again.
26072607

26082608
## `http.METHODS`

0 commit comments

Comments
 (0)