diff options
| author | Calvin Metcalf <cmetcalf@appgeo.com> | 2017-05-05 16:57:57 +0300 |
|---|---|---|
| committer | Matteo Collina <hello@matteocollina.com> | 2017-11-15 16:30:39 +0300 |
| commit | 157df5a47c3aa8951e5dba4f0b05c7a9c7d9ecb1 (patch) | |
| tree | 402e17f9628dc0590831c5dc836ae37ae0eb2416 /doc | |
| parent | 9c1b18a59f2514e7bccbd07108b5f1f4e6f7c05e (diff) | |
stream: remove usage of *State.highWaterMark
Replaced _readableState.highWaterMark with a .readableHighWaterMark
getter and _writableState.highWaterMark with a .writableHighWaterMark
getter.
The getters are non-enumerable because they break some prototype
manipulation that happen in the ecosystem.
Ref: https://github.com/nodejs/node/issues/445.
PR-URL: https://github.com/nodejs/node/pull/12860
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 6ee01646620..25a218cf130 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -437,6 +437,14 @@ process.nextTick(() => { See also: [`writable.cork()`][]. +##### writable.writableHighWaterMark +<!-- YAML +added: REPLACEME +--> + +Return the value of `highWaterMark` passed when constructing this +`Writable`. + ##### writable.write(chunk[, encoding][, callback]) <!-- YAML added: v0.9.4 @@ -879,6 +887,14 @@ to prevent memory leaks. never closed until the Node.js process exits, regardless of the specified options. +##### readable.readableHighWaterMark +<!-- YAML +added: REPLACEME +--> + +Return the value of `highWaterMark` passed when constructing this +`Readable`. + ##### readable.read([size]) <!-- YAML added: v0.9.4 |