From ebc3876754de3d3b0ddd33697a5e3f38e8c488e2 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Wed, 10 Jul 2019 16:04:45 +0200 Subject: [PATCH] doc: add missing types 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 Reviewed-By: Trivikram Kamat Reviewed-By: Anna Henningsen Reviewed-By: Jiawen Geng Reviewed-By: Ruben Bridgewater Reviewed-By: Rich Trott --- doc/api/stream.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/stream.md b/doc/api/stream.md index 4a041e63ecc703..16edb6d80ba310 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -504,6 +504,8 @@ Return the value of `highWaterMark` passed when constructing this added: v9.4.0 --> +* {number} + This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. @@ -513,6 +515,8 @@ the status of the `highWaterMark`. added: v12.3.0 --> +* {boolean} + Getter for the property `objectMode` of a given `Writable` stream. ##### writable.write(chunk[, encoding][, callback]) @@ -1107,6 +1111,8 @@ the status of the `highWaterMark`. added: v12.3.0 --> +* {boolean} + Getter for the property `objectMode` of a given `Readable` stream. ##### readable.resume()