Not documented: stream.readable() is fired once when read is impossible #14597

socketpair · 2015-04-10T23:08:41Z

Not documented: stream.readable() is fired once when read is impossible. I think, that just before 'end' event.

Current documentation says: When a chunk of data can be read from the stream. But in that case, chunk CAN_NOT be read (stream.read() will return null).

The text was updated successfully, but these errors were encountered:

jasnell · 2015-06-25T20:35:41Z

It's a bit confusing but it's not a bug. readable tells you that data can be read, it does not tell you if there is actually data that will be read. Your code has to be prepared to get a null back when calling read. The example https://nodejs.org/api/stream.html#stream_readable_read_size illustrates such handling.

socketpair · 2015-06-26T03:44:10Z

Please reopen. I understand that this is not a bug, but as I think, this non-trivial thing should be documented. For example, is it guaranteed that readable will be fired BEFORE end ? moreover, is it guaranteed that readable will fire if connection aborted on remote side?

jasnell · 2015-06-26T03:59:57Z

OK. Care to help out with a PR? :)

per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point.

jasnell · 2015-07-06T18:41:41Z

I've got a PR open to clarify this. Will land shortly once reviewed.

per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point.

per #14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25635

per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635

per #14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25591

per nodejs/node-v0.x-archive#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs/node-v0.x-archive#25591

per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25591

socketpair changed the title ~~Not documented: stream.readable() is fired when read is impossible~~ Not documented: stream.readable() is fired once when read is impossible Apr 10, 2015

jasnell added doc streams labels Jun 25, 2015

jasnell closed this as completed Jun 25, 2015

jasnell reopened this Jun 26, 2015

jasnell closed this as completed Jul 6, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Not documented: stream.readable() is fired once when read is impossible #14597

Not documented: stream.readable() is fired once when read is impossible #14597

socketpair commented Apr 10, 2015

jasnell commented Jun 25, 2015

socketpair commented Jun 26, 2015

jasnell commented Jun 26, 2015

jasnell commented Jul 6, 2015

Not documented: stream.readable() is fired once when read is impossible #14597

Not documented: stream.readable() is fired once when read is impossible #14597

Comments

socketpair commented Apr 10, 2015

jasnell commented Jun 25, 2015

socketpair commented Jun 26, 2015

jasnell commented Jun 26, 2015

jasnell commented Jul 6, 2015