Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: document process.{stderr.fd, stdin.fd, stdout.fd} #31395

Closed
wants to merge 3 commits into from
Closed

doc: document process.{stderr.fd, stdin.fd, stdout.fd} #31395

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bab9baf
doc: document process.std*.fd
HarshithaKP Jan 17, 2020
a89248c
fixup: address review comment
HarshithaKP Jan 17, 2020
bad564f
fixup: address review comment
HarshithaKP Jan 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2158,6 +2158,14 @@ a [Writable][] stream.
`process.stderr` differs from other Node.js streams in important ways. See
[note on process I/O][] for more information.

### `process.stderr.fd`

* {number}

This property refers to the value of underlying file descriptor of
`process.stderr`. The value is fixed at `2`. In `worker_thread`s,
addaleax marked this conversation as resolved.
Show resolved Hide resolved
this field does not exist.

## `process.stdin`

* {Stream}
Expand Down Expand Up @@ -2191,6 +2199,14 @@ In "old" streams mode the `stdin` stream is paused by default, so one
must call `process.stdin.resume()` to read from it. Note also that calling
`process.stdin.resume()` itself would switch stream to "old" mode.

### `process.stdin.fd`

* {number}

This property refers to the value of underlying file descriptor of
`process.stdin`. The value is fixed at `0`. In `worker_thread`s,
this field does not exist.

## `process.stdout`

* {Stream}
Expand All @@ -2209,6 +2225,14 @@ process.stdin.pipe(process.stdout);
`process.stdout` differs from other Node.js streams in important ways. See
[note on process I/O][] for more information.

### `process.stdout.fd`

* {number}

This property refers to the value of underlying file descriptor of
`process.stdout`. The value is fixed at `1`. In `worker_thread`s,
this field does not exist.

### A note on process I/O

`process.stdout` and `process.stderr` differ from other Node.js streams in
Expand Down