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.

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: clarify subprocess.stdout/in/err/io properties #36784

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1508,6 +1508,9 @@ then this will be `null`.
`subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will
refer to the same value.

The `subprocess.stderr` property can be `null` if the child process could
not be successfully spawned.

### `subprocess.stdin`
<!-- YAML
added: v0.1.90
Expand All @@ -1526,6 +1529,9 @@ then this will be `null`.
`subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will
refer to the same value.

The `subprocess.stdin` property can be `undefined` if the child process could
not be successfully spawned.

### `subprocess.stdio`
<!-- YAML
added: v0.7.10
Expand Down Expand Up @@ -1566,6 +1572,9 @@ assert.strictEqual(subprocess.stdio[2], null);
assert.strictEqual(subprocess.stdio[2], subprocess.stderr);
```

The `subprocess.stdio` property can be `undefined` if the child process could
not be successfully spawned.

### `subprocess.stdout`
<!-- YAML
added: v0.1.90
Expand All @@ -1591,6 +1600,9 @@ subprocess.stdout.on('data', (data) => {
});
```

The `subprocess.stdout` property can be `null` if the child process could
not be successfully spawned.

### `subprocess.unref()`
<!-- YAML
added: v0.7.10
Expand Down