summaryrefslogtreecommitdiff
path: root/doc/api/stream.md
diff options
context:
space:
mode:
authorGuy Margalit <guymguym@gmail.com>2017-08-05 02:12:24 +0300
committerMatteo Collina <hello@matteocollina.com>2017-08-08 11:18:25 +0200
commitc3c045aea06a4d58b4af5c1bdc4f8aebbe5425e4 (patch)
treeb967030d617a6b388549ce151de6212f2b436924 /doc/api/stream.md
parent4da8b99a74c9d00a3733d50c6348750360bf1c40 (diff)
downloadandroid-node-v8-c3c045aea06a4d58b4af5c1bdc4f8aebbe5425e4.tar.gz
android-node-v8-c3c045aea06a4d58b4af5c1bdc4f8aebbe5425e4.tar.bz2
android-node-v8-c3c045aea06a4d58b4af5c1bdc4f8aebbe5425e4.zip
stream: support readable/writableHWM for Duplex
This commits adds support for readableHighWaterMark and writableHighWaterMark in Duplex stream, so that they can be set without accessing the internal state. Fixes: https://github.com/nodejs/node/issues/14555 PR-URL: https://github.com/nodejs/node/pull/14636 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r--doc/api/stream.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 743bea7955..c26ab800fa 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1752,6 +1752,10 @@ constructor and implement *both* the `readable._read()` and
* `writableObjectMode` {boolean} Defaults to `false`. Sets `objectMode`
for writable side of the stream. Has no effect if `objectMode`
is `true`.
+ * `readableHighWaterMark` {number} Sets `highWaterMark` for the readable side
+ of the stream. Has no effect if `highWaterMark` is provided.
+ * `writableHighWaterMark` {number} Sets `highWaterMark` for the writable side
+ of the stream. Has no effect if `highWaterMark` is provided.
For example: