Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Nagy <ronagy@icloud.com>2020-02-15 16:13:29 +0300
committerRobert Nagy <ronagy@icloud.com>2020-02-19 02:28:46 +0300
commit7c524fb092b143470795c8ca869de4654c728fe1 (patch)
treeb5f906c80f7026d1f71e438207b461c33641ef80 /doc/api/stream.md
parent31290824de068eb4b282ab74829450b988ae225b (diff)
doc: fix Writable.write callback description
Clarifies a userland invariant until a better solution can be found. Also moves a misplaced sentence from _write to write. Refs: https://github.com/nodejs/node/pull/31756 Refs: https://github.com/nodejs/node/pull/31765 PR-URL: https://github.com/nodejs/node/pull/31812 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r--doc/api/stream.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index cf3ecd461c1..acb859f3920 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -585,8 +585,8 @@ The `writable.write()` method writes some data to the stream, and calls the
supplied `callback` once the data has been fully handled. If an error
occurs, the `callback` *may or may not* be called with the error as its
first argument. To reliably detect write errors, add a listener for the
-`'error'` event. If `callback` is called with an error, it will be called
-before the `'error'` event is emitted.
+`'error'` event. The `callback` is called asynchronously and before `'error'` is
+emitted.
The return value is `true` if the internal buffer is less than the
`highWaterMark` configured when the stream was created after admitting `chunk`.
@@ -1890,8 +1890,8 @@ methods only.
The `callback` method must be called to signal either that the write completed
successfully or failed with an error. The first argument passed to the
`callback` must be the `Error` object if the call failed or `null` if the
-write succeeded. The `callback` method will always be called asynchronously and
-before `'error'` is emitted.
+write succeeded. The `callback` must be called synchronously inside of
+`writable._write()` or asynchronously (i.e. different tick).
All calls to `writable.write()` that occur between the time `writable._write()`
is called and the `callback` is called will cause the written data to be