Skip to content

doc: clarify writable.cork method #30442

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

Closed
GKJCJG wants to merge 8 commits into from
Closed

doc: clarify writable.cork method #30442

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
521adde
Clarify role of writable.cork()
GKJCJG Nov 12, 2019
a4c2e36
doc: Clarify role of writable.cork()
GKJCJG Nov 14, 2019
61d7d1f
Improving syntax minorly.
GKJCJG Nov 14, 2019
3fbb958
Simplify description of performance problems
GKJCJG Nov 17, 2019
5ba141a
Adopt suggestions from mcollina
GKJCJG Nov 21, 2019
845738c
removing forbidden strings and fixing link.
GKJCJG Nov 21, 2019
cde9d5f
Update doc/api/stream.md
GKJCJG Dec 3, 2019
c2b161a
Update doc/api/stream.md
GKJCJG Dec 3, 2019
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
Prev Previous commit
Next Next commit
removing forbidden strings and fixing link.
  • Loading branch information
@GKJCJG
GKJCJG authored Nov 21, 2019
commit 845738c7428755959f33d1843d3b1a8123c48b1e
7 changes: 3 additions & 4 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,12 +364,11 @@ immediately forwarding them to the underlining destination, `writable.cork()`
buffers all the chunks until `writable.uncork()` is called, which will pass
them all to `writable._writev()`, if present. This prevents an head-of-line
Comment thread
GKJCJG marked this conversation as resolved.
Resolved
blocking situation where data is being buffered while waiting for the first
small chunk to be processed.
small chunk to be processed. However, use of `writable.cork()` without
implementing `writable._writev()` may have an adverse effect on throughput.

Note that using `writable.cork()` without implementing `writable._writev()` is
likely to have an adverse effect on throughput.

See also: [`writable.uncork()`][], [`writable._writev(chunks, callback)`][].
See also: [`writable.uncork()`][], [`writable._writev()`][stream-_writev].

##### writable.destroy(\[error\])
<!-- YAML
Expand Down