Browse Source

doc: fix two doc errors in stream and process

`process.stdout` always blocks as of
20176a9841

`WritableState.buffer` is `getBuffer()` as of
91586661c9

PR-URL: https://github.com/nodejs/node/pull/2549
Reviewed-By: Alexis Campailla <orangemocha@nodejs.org>
Reviewed-By: Evan Lucas <evanlucas@me.com>
v5.x
Jeremiah Senkpiel 9 years ago
parent
commit
892bf65d9a
  1. 8
      doc/api/process.markdown
  2. 4
      doc/api/stream.markdown

8
doc/api/process.markdown

@ -256,13 +256,7 @@ For example, a `console.log` equivalent could look like this:
`process.stderr` and `process.stdout` are unlike other streams in Node.js in `process.stderr` and `process.stdout` are unlike other streams in Node.js in
that they cannot be closed (`end()` will throw), they never emit the `finish` that they cannot be closed (`end()` will throw), they never emit the `finish`
event and that writes are usually blocking. event and that writes are always blocking.
- They are blocking in the case that they refer to regular files or TTY file
descriptors.
- In the case they refer to pipes:
- They are blocking in Linux/Unix.
- They are non-blocking like other streams in Windows.
To check if Node.js is being run in a TTY context, read the `isTTY` property To check if Node.js is being run in a TTY context, read the `isTTY` property
on `process.stderr`, `process.stdout`, or `process.stdin`: on `process.stderr`, `process.stdout`, or `process.stdin`:

4
doc/api/stream.markdown

@ -1440,8 +1440,8 @@ var transform = new stream.Transform({
<!--type=misc--> <!--type=misc-->
Both Writable and Readable streams will buffer data on an internal Both Writable and Readable streams will buffer data on an internal
object called `_writableState.buffer` or `_readableState.buffer`, object which can be retrieved from `_writableState.getBuffer()` or
respectively. `_readableState.buffer`, respectively.
The amount of data that will potentially be buffered depends on the The amount of data that will potentially be buffered depends on the
`highWaterMark` option which is passed into the constructor. `highWaterMark` option which is passed into the constructor.

Loading…
Cancel
Save