@@ -860,6 +860,8 @@ added: v0.9.4
860
860
* ` destination ` {stream.Writable} The destination for writing data
861
861
* ` options ` {Object} Pipe options
862
862
* ` end ` {boolean} End the writer when the reader ends. Defaults to ` true ` .
863
+ * Returns: {stream.Writable} making it possible to set up chains of piped
864
+ streams
863
865
864
866
The ` readable.pipe() ` method attaches a [ Writable] [ ] stream to the ` readable ` ,
865
867
causing it to switch automatically into flowing mode and push all of its data
@@ -916,7 +918,9 @@ closed until the Node.js process exits, regardless of the specified options.
916
918
added: v9.3.0
917
919
-->
918
920
919
- Return the value of ` highWaterMark ` passed when constructing this
921
+ * Returns: {number}
922
+
923
+ Returns the value of ` highWaterMark ` passed when constructing this
920
924
` Readable ` .
921
925
922
926
##### readable.read([ size] )
@@ -925,7 +929,7 @@ added: v0.9.4
925
929
-->
926
930
927
931
* ` size ` {number} Optional argument to specify how much data to read.
928
- * Return {string|Buffer|null}
932
+ * Returns: {string|Buffer|null}
929
933
930
934
The ` readable.read() ` method pulls some data out of the internal buffer and
931
935
returns it. If no data available to be read, ` null ` is returned. By default,
@@ -970,6 +974,8 @@ been emitted will return `null`. No runtime error will be raised.
970
974
added: v9.4.0
971
975
-->
972
976
977
+ * Returns: {number}
978
+
973
979
This property contains the number of bytes (or objects) in the queue
974
980
ready to be read. The value provides introspection data regarding
975
981
the status of the ` highWaterMark ` .
@@ -1034,6 +1040,7 @@ added: v0.9.4
1034
1040
-->
1035
1041
1036
1042
* ` destination ` {stream.Writable} Optional specific stream to unpipe
1043
+ * Returns: {this}
1037
1044
1038
1045
The ` readable.unpipe() ` method detaches a Writable stream previously attached
1039
1046
using the [ ` stream.pipe() ` ] [ ] method.
@@ -1135,6 +1142,7 @@ added: v0.9.4
1135
1142
-->
1136
1143
1137
1144
* ` stream ` {Stream} An "old style" readable stream
1145
+ * Returns: {this}
1138
1146
1139
1147
Versions of Node.js prior to v0.10 had streams that did not implement the
1140
1148
entire ` stream ` module API as it is currently defined. (See [ Compatibility] [ ]
@@ -1165,6 +1173,9 @@ myReader.on('readable', () => {
1165
1173
added: v8.0.0
1166
1174
-->
1167
1175
1176
+ * ` error ` {Error} Error which will be passed as payload in ` 'error' ` event
1177
+ * Returns: {this}
1178
+
1168
1179
Destroy the stream, and emit ` 'error' ` and ` close ` . After this call, the
1169
1180
readable stream will release any internal resources and subsequent calls
1170
1181
to ` push ` will be ignored.
0 commit comments