doc: missing stream.Readable.ReadableState and stream.Writable.WritableState

[pd4d10]

📗 API Reference Docs Problem

• Version: 16
• Platform: All
• Subsystem: stream

Location

• https://nodejs.org/api/stream.html

Description

stream.Readable.ReadableState and stream.Writable.WritableState are user accessible, but there seems to be no doc of them.

---

• I would like to work on this issue and
  submit a pull request.

[Ayase-252]

IIRC, the only way user could access them is this._readableState or this._writableState. I think the leading _ marks them as internal use only.

[Trott]

Related: #445

[mcollina]

Thanks for reporting. I'll close this: those are not documented because they are private.

[mcollina]

cc @nodejs/streams

[ronag]

IMO. They are and should remain private (or as private as we can make them).

[pd4d10]

Get it. Shall we keep it private, for example, remove this line?

node/lib/internal/streams/readable.js

Line 39 in 0996eb7

Readable.ReadableState = ReadableState;

If so I guess it also requires CITGM tests.

[mcollina]

I'm not sure what you'd try to accomplish by removing them.

Doing so would require including a deprecation notice and a semver-major cycle.

[pd4d10]

what you'd try to accomplish by removing them

None actually, just noticed that they weren't in the documentation but were exposed to the user

If this is a costly change, I'm also in favor of keeping it as is.

[mcollina]

Unfortunately it is :(. The general wisdom is to avoid disruption if it could be avoided.