Skip to content

streams: remove all references to readableState/writableState from docs

Rodrigo Muino Tomonari requested to merge github/fork/calvinmetcalf/rm-readable-state-docs into master

This removes all the refereces to readableState and writableState from the docs by adding some computed properties to allow for the same functionality that was exposed by the use of readableState and writableState.

We add writeBuffer and readBuffer getters for the state buffers and we have a flowing getter for readableState.flowing, I also add a ._setFlowing for the internal places we need to set the flowing state.

Part of the readableState/writableState mega issue #445. Fixes https://github.com/nodejs/node/issues/6799.

cc @nodejs/streams

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

streams

(edit @mcollina: added link to a open bug on this)

Merge request reports