Skip to content

Commit ebc3876

Browse files
lpincatargos
authored andcommitted
doc: add missing types
Document the types returned by the `readable.readableObjectMode`, `writable.writableLength`, and `writable.writableObjectMode` getters. PR-URL: #28623 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent f7a13e5 commit ebc3876

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/stream.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,8 @@ Return the value of `highWaterMark` passed when constructing this
504504
added: v9.4.0
505505
-->
506506

507+
* {number}
508+
507509
This property contains the number of bytes (or objects) in the queue
508510
ready to be written. The value provides introspection data regarding
509511
the status of the `highWaterMark`.
@@ -513,6 +515,8 @@ the status of the `highWaterMark`.
513515
added: v12.3.0
514516
-->
515517

518+
* {boolean}
519+
516520
Getter for the property `objectMode` of a given `Writable` stream.
517521

518522
##### writable.write(chunk[, encoding][, callback])
@@ -1107,6 +1111,8 @@ the status of the `highWaterMark`.
11071111
added: v12.3.0
11081112
-->
11091113

1114+
* {boolean}
1115+
11101116
Getter for the property `objectMode` of a given `Readable` stream.
11111117

11121118
##### readable.resume()

0 commit comments

Comments
 (0)