doc: copyedit http.OutgoingMessage documentation #42733
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review requested:
|
nodejs-github-bot
added
doc
lpinca
force-pushed
the
copyedit/outgoing-message-documentation
branch
2 times, most recently
from
460a5b0 to
2aa311e
Compare
lpinca
commented
Apr 14, 2022
Comment on lines
-2804
to
+2807
| If this method is called and the header is not sent, it will call | ||
| `this._implicitHeader` to flush implicit header. | ||
| If the message should not have a body (indicated by `this._hasBody`), | ||
| the call is ignored and `chunk` will not be sent. It could be useful | ||
| when handling a particular message which must not include a body. | ||
| e.g. response to `HEAD` request, `204` and `304` response. | ||
| Sends a chunk of the body. This method can be called multiple times. | ||
|
|
||
| `chunk` can be a string or a buffer. When `chunk` is a string, the | ||
| `encoding` parameter specifies how to encode `chunk` into a byte stream. | ||
| `callback` will be called when the `chunk` is flushed. | ||
| The `encoding` argument is only relevant when `chunk` is a string. Defaults to | ||
| `'utf8'`. | ||
|
|
||
| If the message is transferred in chucked encoding | ||
| (indicated by `this.chunkedEncoding`), `chunk` will be flushed as | ||
| one chunk among a stream of chunks. Otherwise, it will be flushed as the | ||
| body of message. | ||
|
|
||
| This method handles the raw body of the HTTP message and has nothing to do | ||
| with higher-level multi-part body encodings that may be used. | ||
|
|
||
| If it is the first call to this method of a message, it will send the | ||
| buffered header first, then flush the `chunk` as described above. | ||
|
|
||
| The second and successive calls to this method will assume the data | ||
| will be streamed and send the new data separately. It means that the response | ||
| is buffered up to the first chunk of the body. | ||
| The `callback` argument is optional and will be called when this chunk of data | ||
| is flushed. | ||
|
|
||
| Returns `true` if the entire data was flushed successfully to the kernel | ||
| buffer. Returns `false` if all or part of the data was queued in the user | ||
| memory. Event `drain` will be emitted when the buffer is free again. | ||
| memory. The `'drain'` event will be emitted when the buffer is free again. |
There was a problem hiding this comment.
I've simplified this because a detailed and specific description exists for both ClientRequest#write() and ServerResponse#write().
Fix nits/typos and simplify some sentences.
lpinca
force-pushed
the
copyedit/outgoing-message-documentation
branch
from
2aa311e to
f2785c1
Compare
lpinca
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 0699150 |
xtx1130
pushed a commit
to xtx1130/node
that referenced
this pull request
Apr 25, 2022
Fix nits/typos and simplify some sentences. PR-URL: nodejs#42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
targos
pushed a commit
that referenced
this pull request
Apr 28, 2022
Fix nits/typos and simplify some sentences. PR-URL: #42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
juanarbol
pushed a commit
that referenced
this pull request
May 31, 2022
Fix nits/typos and simplify some sentences. PR-URL: #42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
danielleadams
pushed a commit
that referenced
this pull request
Jun 27, 2022
Fix nits/typos and simplify some sentences. PR-URL: #42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
targos
pushed a commit
that referenced
this pull request
Jul 11, 2022
Fix nits/typos and simplify some sentences. PR-URL: #42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
targos
pushed a commit
that referenced
this pull request
Jul 31, 2022
Fix nits/typos and simplify some sentences. PR-URL: #42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
guangwong
pushed a commit
to noslate-project/node
that referenced
this pull request
Oct 10, 2022
Fix nits/typos and simplify some sentences. PR-URL: nodejs/node#42733 Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix nits/typos and simplify some sentences.