1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix type in stream doc

Browse Source 
Extend return type of `read()` method with `any` which is a
valid return type for readable streams in object mode.

PR-URL: https://github.com/nodejs/node/pull/21178
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
This commit is contained in:
Aliaksei Tuzik 2018-06-07 23:45:35 +03:00 committed by Vse Mozhet Byt
parent 2237a8e45d
commit 00e479fed4
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/stream.md
View File

@ -954,7 +954,7 @@ added: v0.9.4
-->
* `size` {number} Optional argument to specify how much data to read.
* Returns: {string|Buffer|null}
* Returns: {string|Buffer|null|any}
The `readable.read()` method pulls some data out of the internal buffer and
returns it. If no data available to be read, `null` is returned. By default,