Skip to content

Commit

Permalink
doc: add readable and writable property to Readable and Writable
Browse files Browse the repository at this point in the history
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information
dexterleng authored and Trott committed Nov 21, 2018
1 parent e610685 commit 16a2b5c
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.
Expand All @@ -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
Expand Down

0 comments on commit 16a2b5c

Please sign in to comment.