Skip to content

doc: add readable and writable property to Readable and Writable #23933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dexterleng wants to merge 4 commits into from
Closed

doc: add readable and writable property to Readable and Writable #23933

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55cf80b
doc: add readable and writable property to Readable and Writable
dexterleng Oct 28, 2018
db1b5b2
doc: remove returns from Readable properties
dexterleng Oct 28, 2018
8c4ccca
doc: address comment
jasnell Oct 29, 2018
4fb9ffe
fixup! doc: address comment
Trott Nov 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,16 @@ process.nextTick(() => {

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

##### writable.writable
<!-- YAML
added: REPLACEME
-->

* {boolean}

A boolean that is `true` by default, but turns `false` after the
[`stream.end()`][stream-end] method has been called.

##### writable.writableHighWaterMark
<!-- YAML
added: v9.3.0
Expand Down Expand Up @@ -1013,12 +1023,22 @@ also be emitted.
Calling [`stream.read([size])`][stream-read] after the [`'end'`][] event has
been emitted will return `null`. No runtime error will be raised.

##### readable.readable
<!-- YAML
added: REPLACEME
-->

* {boolean}

A boolean that is `true` by default, but turns `false` immediately before
the `'end'` event is emitted.

##### readable.readableHighWaterMark
<!-- YAML
added: v9.3.0
-->

* Returns: {number}
* {number}

Returns the value of `highWaterMark` passed when constructing this
`Readable`.
Expand All @@ -1028,7 +1048,7 @@ Returns the value of `highWaterMark` passed when constructing this
added: v9.4.0
-->

* Returns: {number}
* {number}

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