Stream writable/readable properties are undocumented as of streams2

[strugee]

• Version: 10
• Platform: N/A
• Subsystem: doc

stream.Writable#writable is no longer documented, but according to https://stackoverflow.com/a/23094413/1198896 it exists and probably should be documented. Presumably the same is true for stream.Readable#readable?

[killagu]

+1

[thatshailesh]

https://nodejs.org/docs/v0.9.4/api/stream.html#stream_class_stream_writable
It was there before @Trott would like to know why it was removed? can we add again?

[Trott]

@nodejs/streams

[mcollina]

I think these should be documented. They are used in the wild.

@strugee would you like to send a PR?

[thatshailesh]

I am also willing to help with PR
@strugee let me know if you're not sending :)

[strugee]

Hey, sorry for the delay! I looked into this briefly and realized I'd have to dig through the source to make sure I had the right implementation details, and I haven't had time to do that yet. @thatshailesh given the situation, if you want to take this then by all means go ahead! Otherwise I can do this when I find some time :)

[thatshailesh]

Ok Sure, I'll send it thanks :)

[thatshailesh]

@strugee Hey I just found this
Writable - https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_constructor_new_stream_writable_options
Readable - https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_implementing_a_readable_stream

Both are there in the doc, hope it resolves the issue :)

[felixrabe]

@thatshailesh - no, you linked to the uppercase Readable and Writable classes, whereas this issue is about the lowercase readable and writable properties which are still (last I checked) undocumented.

[strugee]

@felixrabe is correct. What we are looking for is something like https://nodejs.org/docs/v0.8.0/api/stream.html#stream_stream_readable, but note that that's for 0.8 streams and not streams2, which is why I said I'd have to dig into the implementation to make sure I wrote something correct.

[mcollina]

Those properties are sill there, and I suspect they still work as before. I think they are still there for compatibility reason. You might want to add unit tests for them if there are none.

[ronkorving]

So, I just wrote an issue and closed it as a duplicate. It is however not exactly a duplicate, but probably worth covering in the same breath as this issue.

net.Socket has a writable property. It does not initialize it in its constructor, so it depends on the Writable for it, which sets it to true in its constructor. After a successful connection, net.Socket sets it to true, which seems rather pointless since it was already true from construction time. Maybe this code is acceptable, if we decide that Writable owns it, and Writable stream implementations are always responsible for keeping that value correct.