mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
doc: additional refinement to readable event
Per https://github.com/joyent/node/pull/25635#discussion_r33973696 Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25591
This commit is contained in:
1 parent
881d9bea01
commit
eda2560cdc
1 file changed
+4
-5
@@ -167,11 +167,10 @@ again when more data is available.
|
||||
The `readable` event is not emitted in the "flowing" mode with the
|
||||
sole exception of the last one, on end-of-stream.
|
||||
|
||||
Note that the `'readable'` event indicates only that data *can* be
|
||||
read from the stream. It does not indicate whether there is actual
|
||||
data to be consumed. The callback passed to handle the `'readable'`
|
||||
event must be prepared to handle a `null` response from
|
||||
`readable.read([size])`. For instance, in the following example, `foo.txt`
|
||||
The 'readable' event indicates that the stream has new information:
|
||||
either new data is available or the end of the stream has been reached.
|
||||
In the former case, `.read()` will return that data. In the latter case,
|
||||
`.read()` will return null. For instance, in the following example, `foo.txt`
|
||||
is an empty file:
|
||||
|
||||
```javascript
|
||||
|
||||
Reference in new issue
Block a user