Skip to content

Commit 41f2e36

Browse files
dexterlengrvagg
authored andcommitted
doc: add readable and writable property to Readable and Writable
PR-URL: #23933 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
1 parent 4792bea commit 41f2e36

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

doc/api/stream.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,15 @@ process.nextTick(() => {
463463

464464
See also: [`writable.cork()`][].
465465

466+
##### writable.writable
467+
<!-- YAML
468+
added: REPLACEME
469+
-->
470+
471+
* {boolean}
472+
473+
Is `true` if it is safe to call [`writable.write()`][].
474+
466475
##### writable.writableHighWaterMark
467476
<!-- YAML
468477
added: v9.3.0
@@ -1013,12 +1022,21 @@ also be emitted.
10131022
Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has
10141023
been emitted will return `null`. No runtime error will be raised.
10151024

1025+
##### readable.readable
1026+
<!-- YAML
1027+
added: REPLACEME
1028+
-->
1029+
1030+
* {boolean}
1031+
1032+
Is `true` if it is safe to call [`readable.read()`][].
1033+
10161034
##### readable.readableHighWaterMark
10171035
<!-- YAML
10181036
added: v9.3.0
10191037
-->
10201038

1021-
* Returns: {number}
1039+
* {number}
10221040

10231041
Returns the value of `highWaterMark` passed when constructing this
10241042
`Readable`.
@@ -1028,7 +1046,7 @@ Returns the value of `highWaterMark` passed when constructing this
10281046
added: v9.4.0
10291047
-->
10301048

1031-
* Returns: {number}
1049+
* {number}
10321050

10331051
This property contains the number of bytes (or objects) in the queue
10341052
ready to be read. The value provides introspection data regarding

0 commit comments

Comments
 (0)