1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add links between cork() and uncork()

Browse Source 
Writable.cork() and Writable.uncork() are meant to be documented
together, but we maintain a lexicographic order. This commit
introduces some links between the two.

Fixes: https://github.com/nodejs/node/issues/7340
PR-URL: https://github.com/nodejs/node/pull/11222
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This commit is contained in:
Matteo Collina 2017-02-07 19:10:03 +01:00
parent 2db3b941a9
commit c38b6d2021
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/stream.md
View File

@ -347,6 +347,8 @@ buffer that would have an adverse impact on performance. In such situations,
implementations that implement the `writable._writev()` method can perform implementations that implement the `writable._writev()` method can perform
buffered writes in a more optimized manner. buffered writes in a more optimized manner.
See also: [`writable.uncork()`][].
##### writable.end([chunk][, encoding][, callback]) ##### writable.end([chunk][, encoding][, callback])
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
@ -394,7 +396,7 @@ added: v0.11.2
The `writable.uncork()` method flushes all data buffered since The `writable.uncork()` method flushes all data buffered since
[`stream.cork()`][] was called. [`stream.cork()`][] was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering When using [`writable.cork()`][] and `writable.uncork()` to manage the buffering
of writes to a stream, it is recommended that calls to `writable.uncork()` be of writes to a stream, it is recommended that calls to `writable.uncork()` be
deferred using `process.nextTick()`. Doing so allows batching of all deferred using `process.nextTick()`. Doing so allows batching of all
`writable.write()` calls that occur within a given Node.js event loop phase. `writable.write()` calls that occur within a given Node.js event loop phase.
@ -406,7 +408,7 @@ stream.write('data ');
process.nextTick(() => stream.uncork()); process.nextTick(() => stream.uncork());
``` ```
If the `writable.cork()` method is called multiple times on a stream, the same If the [`writable.cork()`][] method is called multiple times on a stream, the same
number of calls to `writable.uncork()` must be called to flush the buffered number of calls to `writable.uncork()` must be called to flush the buffered
data. data.
@ -422,6 +424,8 @@ process.nextTick(() => {
}); });
``` ```
See also: [`writable.cork()`][].
##### writable.write(chunk[, encoding][, callback]) ##### writable.write(chunk[, encoding][, callback])
<!-- YAML <!-- YAML
added: v0.9.4 added: v0.9.4
@ -2018,6 +2022,8 @@ readable buffer so there is nothing for a user to consume.
[`stream.uncork()`]: #stream_writable_uncork [`stream.uncork()`]: #stream_writable_uncork
[`stream.unpipe()`]: #stream_readable_unpipe_destination [`stream.unpipe()`]: #stream_readable_unpipe_destination
[`stream.wrap()`]: #stream_readable_wrap_stream [`stream.wrap()`]: #stream_readable_wrap_stream
[`writable.cork()`]: #stream_writable_cork
[`writable.uncork()`]: #stream_writable_uncork
[API for Stream Consumers]: #stream_api_for_stream_consumers [API for Stream Consumers]: #stream_api_for_stream_consumers
[API for Stream Implementers]: #stream_api_for_stream_implementers [API for Stream Implementers]: #stream_api_for_stream_implementers
[child process stdin]: child_process.html#child_process_child_stdin [child process stdin]: child_process.html#child_process_child_stdin