Skip to content

Commit bab9baf

Browse files
committed
doc: document process.std*.fd
Fixes: nodejs#28386 Refs: nodejs#31292 Refs: nodejs/help#2136
1 parent 9530362 commit bab9baf

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/api/process.md

+24
Original file line numberDiff line numberDiff line change
@@ -2158,6 +2158,14 @@ a [Writable][] stream.
21582158
`process.stderr` differs from other Node.js streams in important ways. See
21592159
[note on process I/O][] for more information.
21602160

2161+
### `process.stderr.fd`
2162+
2163+
* {number}
2164+
2165+
This property refers to the value of underlying file descriptor
2166+
(in POSIX) or handle (an abstract resource reference in Windows) of
2167+
`process.stderr`. In `worker_thread`s, this field does not exist.
2168+
21612169
## `process.stdin`
21622170

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

2202+
### `process.stdin.fd`
2203+
2204+
* {number}
2205+
2206+
This property refers to the value of underlying file descriptor
2207+
(in POSIX) or handle (an abstract resource reference in Windows) of
2208+
`process.stdin`. In `worker_thread`s, this field does not exist.
2209+
21942210
## `process.stdout`
21952211

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

2228+
### `process.stdout.fd`
2229+
2230+
* {number}
2231+
2232+
This property refers to the value of underlying file descriptor
2233+
(in POSIX) or handle (an abstract resource reference in Windows) of
2234+
`process.stdout`. In `worker_thread`s, this field does not exist.
2235+
22122236
### A note on process I/O
22132237

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

0 commit comments

Comments
 (0)