diff options
| author | Calvin Metcalf <cmetcalf@appgeo.com> | 2017-05-05 14:42:21 +0200 |
|---|---|---|
| committer | Matteo Collina <hello@matteocollina.com> | 2017-12-18 14:41:43 +0100 |
| commit | 36ffa21af248c4f3d188d48e06c21e7ec8abe58d (patch) | |
| tree | b9473613a2fb5e52fbbeb4decbfc8fa4052edbe1 /doc/api/stream.md | |
| parent | 0a28f94df6e23f7669fd0fa9e52f7174175f78c4 (diff) | |
| download | android-node-v8-36ffa21af248c4f3d188d48e06c21e7ec8abe58d.tar.gz android-node-v8-36ffa21af248c4f3d188d48e06c21e7ec8abe58d.tar.bz2 android-node-v8-36ffa21af248c4f3d188d48e06c21e7ec8abe58d.zip | |
stream: rm {writeable/readable}State.length
As part of the readableState/writableState mega issue #445, this
removes all of the references to .length on those properties and
replaces them with a readableLength and writableLength getter.
See: https://github.com/nodejs/node/issues/445
PR-URL: https://github.com/nodejs/node/pull/12857
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index dc74df7720..741f105464 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -441,10 +441,18 @@ See also: [`writable.cork()`][]. <!-- YAML added: v9.3.0 --> - Return the value of `highWaterMark` passed when constructing this `Writable`. +##### writable.writableLength +<!-- YAML +added: REPLACEME +--> + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + ##### writable.write(chunk[, encoding][, callback]) <!-- YAML added: v0.9.4 @@ -945,6 +953,15 @@ event will also be emitted. *Note*: Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has been emitted will return `null`. No runtime error will be raised. +##### readable.readableLength +<!-- YAML +added: REPLACEME +--> + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + ##### readable.resume() <!-- YAML added: v0.9.4 |