mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 20:02:04 +00:00
doc: stdout/stderr can block when directed to file
Update the documentation for `process.stdout` and `process.stdout` to clarify that writes can block when stdio is redirected to a file. In all other cases, it's non-blocking. PR-URL: https://github.com/nodejs/node/pull/3170 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
This commit is contained in:
parent
363a4e9223
commit
dac1d38a02
@ -282,7 +282,9 @@ 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 always blocking.
|
event and that writes can block when output is redirected to a file (although
|
||||||
|
disks are fast and operating systems normally employ write-back caching so it
|
||||||
|
should be a very rare occurrence indeed.)
|
||||||
|
|
||||||
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`:
|
||||||
@ -305,14 +307,9 @@ A writable stream to stderr (on fd `2`).
|
|||||||
|
|
||||||
`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 can block when output is redirected to a file (although
|
||||||
|
disks are fast and operating systems normally employ write-back caching so it
|
||||||
- They are blocking in the case that they refer to regular files or TTY file
|
should be a very rare occurrence indeed.)
|
||||||
descriptors.
|
|
||||||
- In the case they refer to pipes:
|
|
||||||
- They are blocking in Linux/Unix.
|
|
||||||
- They are non-blocking like other streams in Windows.
|
|
||||||
|
|
||||||
|
|
||||||
## process.stdin
|
## process.stdin
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user