Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 9ca24de

Browse filesBrowse files
zoubinMyles Borins
authored andcommitted
doc: add docs for more stream options
PR-URL: #4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
1 parent baa0a3d commit 9ca24de
Copy full SHA for 9ca24de

File tree

Expand file treeCollapse file tree

1 file changed

+6
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+6
-1
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.markdown‎

Copy file name to clipboardExpand all lines: doc/api/stream.markdown
+6-1Lines changed: 6 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -856,6 +856,7 @@ implement Readable streams in your programs.
856856
* `objectMode` {Boolean} Whether this stream should behave
857857
as a stream of objects. Meaning that stream.read(n) returns
858858
a single value instead of a Buffer of size n. Default=false
859+
* `read` {Function} Implementation for the [`_read()`][] method.
859860

860861
In classes that extend the Readable class, make sure to call the
861862
Readable constructor so that the buffering settings can be properly
@@ -1108,7 +1109,9 @@ also implement the `_flush()` method. (See below.)
11081109
#### new stream.Transform([options])
11091110

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

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

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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.