diff options
| author | Dexter Leng <dexterlengcs@gmail.com> | 2018-10-28 11:55:22 +0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-11-21 10:49:47 -0800 |
| commit | 16a2b5c7a694593bd39eb2d143da03f20070f2ce (patch) | |
| tree | 52a4d6bf1cc326257b3bad80bf22d7875018fed5 | |
| parent | e610685c9d69f3fc80905b0292c9b0a63d2ac059 (diff) | |
| download | android-node-v8-16a2b5c7a694593bd39eb2d143da03f20070f2ce.tar.gz android-node-v8-16a2b5c7a694593bd39eb2d143da03f20070f2ce.tar.bz2 android-node-v8-16a2b5c7a694593bd39eb2d143da03f20070f2ce.zip | |
doc: add readable and writable property to Readable and Writable
PR-URL: https://github.com/nodejs/node/pull/23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
| -rw-r--r-- | doc/api/stream.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index d5cabbc57e..a98a296077 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -463,6 +463,15 @@ process.nextTick(() => { See also: [`writable.cork()`][]. +##### writable.writable +<!-- YAML +added: REPLACEME +--> + +* {boolean} + +Is `true` if it is safe to call [`writable.write()`][]. + ##### writable.writableHighWaterMark <!-- YAML added: v9.3.0 @@ -1013,12 +1022,21 @@ also be emitted. Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has been emitted will return `null`. No runtime error will be raised. +##### readable.readable +<!-- YAML +added: REPLACEME +--> + +* {boolean} + +Is `true` if it is safe to call [`readable.read()`][]. + ##### readable.readableHighWaterMark <!-- YAML added: v9.3.0 --> -* Returns: {number} +* {number} Returns the value of `highWaterMark` passed when constructing this `Readable`. @@ -1028,7 +1046,7 @@ Returns the value of `highWaterMark` passed when constructing this added: v9.4.0 --> -* Returns: {number} +* {number} This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding |