1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add missing types

Browse Source 
Document the types returned by the `readable.readableObjectMode`,
`writable.writableLength`, and `writable.writableObjectMode` getters.

PR-URL: https://github.com/nodejs/node/pull/28623
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Luigi Pinca 2019-07-10 16:04:45 +02:00 committed by Rich Trott
parent 9e340357df
commit 28e18cfff0
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/stream.md
View File

@ -504,6 +504,8 @@ Return the value of `highWaterMark` passed when constructing this
added: v9.4.0 added: v9.4.0
--> -->
* {number}
This property contains the number of bytes (or objects) in the queue This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding ready to be written. The value provides introspection data regarding
the status of the `highWaterMark`. the status of the `highWaterMark`.
@ -513,6 +515,8 @@ the status of the `highWaterMark`.
added: v12.3.0 added: v12.3.0
--> -->
* {boolean}
Getter for the property `objectMode` of a given `Writable` stream. Getter for the property `objectMode` of a given `Writable` stream.
##### writable.write(chunk[, encoding][, callback]) ##### writable.write(chunk[, encoding][, callback])
@ -1107,6 +1111,8 @@ the status of the `highWaterMark`.
added: v12.3.0 added: v12.3.0
--> -->
* {boolean}
Getter for the property `objectMode` of a given `Readable` stream. Getter for the property `objectMode` of a given `Readable` stream.
##### readable.resume() ##### readable.resume()