doc: add readable and writable property to Readable and Writable #23924
Conversation
nodejs-github-bot
added
doc
doc/api/stream.md
Outdated
| added: REPLACEME | ||
| --> | ||
|
|
||
| * Returns: {boolean} |
There was a problem hiding this comment.
It's a property, not a function, so it does not return a value.
doc/api/stream.md
Outdated
| added: REPLACEME | ||
| --> | ||
|
|
||
| * Returns: {boolean} |
There was a problem hiding this comment.
It's a property, not a function, so it does not return a value.
doc/api/stream.md
Outdated
| @@ -482,6 +482,16 @@ 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`. | |||
|
|
|||
| ##### writable.writable | |||
| <!-- YAML> | |||
doc/api/stream.md
Outdated
| @@ -1034,6 +1044,15 @@ This property contains the number of bytes (or objects) in the queue | |||
| ready to be read. The value provides introspection data regarding | |||
| the status of the `highWaterMark`. | |||
|
|
|||
| ##### readable.readable | |||
| <!-- YAML> | |||
doc/api/stream.md
Outdated
| @@ -482,6 +482,16 @@ 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`. | |||
|
|
|||
| ##### writable.writable | |||
There was a problem hiding this comment.
Properties should be ordered alphabetically in the docs, so this is in the wrong place. It needs to appear above the other writable.writable* properties.
doc/api/stream.md
Outdated
| @@ -1034,6 +1044,15 @@ This property contains the number of bytes (or objects) in the queue | |||
| ready to be read. The value provides introspection data regarding | |||
| the status of the `highWaterMark`. | |||
|
|
|||
| ##### readable.readable | |||
There was a problem hiding this comment.
Properties should be ordered alphabetically in the docs, so this is in the wrong place. It needs to appear above the other readable.readable* properties.
|
Hi, @dexterleng! Welcome and thanks for the pull request! Documentation changes can attract a lot of comments, which sometimes surprises and even frustrates people. Try to be patient and to not get discouraged. Thanks again! |
dexterleng
force-pushed
the
add-doc-readable-writable-props
branch
from
c0cd519
to
35ed66c
Compare
|
Oops. I forced pushed and broke the commit history. Opening a new PR. |
Issue #21431
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes