Skip to content
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

Jump to bottom

doc: add docs for more stream options #4639

Closed
wants to merge 1 commit into from
Closed

doc: add docs for more stream options #4639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion doc/api/stream.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -858,6 +858,7 @@ implement Readable streams in your programs.
* `objectMode` {Boolean} Whether this stream should behave
as a stream of objects. Meaning that stream.read(n) returns
a single value instead of a Buffer of size n. Default=false
* `read` {Function} Implementation for the [`_read()`][] method.

In classes that extend the Readable class, make sure to call the
Readable constructor so that the buffering settings can be properly
Expand Down Expand Up @@ -1111,7 +1112,9 @@ also implement the `_flush()` method. (See below.)
#### new stream.Transform([options])

* `options` {Object} Passed to both Writable and Readable
constructors.
constructors. Also has the following fields:
* `transform` {Function} Implementation for the [`_transform()`][] method.
* `flush` {Function} Implementation for the [`_flush()`][] method.

In classes that extend the Transform class, make sure to call the
constructor so that the buffering settings can be properly
Expand Down Expand Up @@ -1300,6 +1303,8 @@ how to implement Writable streams in your programs.
* `objectMode` {Boolean} Whether or not the `write(anyObj)` is
a valid operation. If set you can write arbitrary data instead
of only `Buffer` / `String` data. Default=false
* `write` {Function} Implementation for the [`_write()`][] method.
* `writev` {Function} Implementation for the [`_writev()`][] method.

In classes that extend the Writable class, make sure to call the
constructor so that the buffering settings can be properly
Expand Down