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: fix documentation for input option in child_process methods [execFile, execFileSync, spawnSync] #49481

Merged
merged 1 commit into from
Sep 6, 2023

Conversation

ariel-weiss
Copy link
Contributor

@ariel-weiss ariel-weiss commented Sep 4, 2023

Updated the documentation for the input option in child_process file, at execFile, execFileSync, spawnSync functions.
This update now clarify that supplying value to the input option will override stdio[0], only if stdio[0] is set to 'pipe'.
This will help avoid confusion when using the input option in any of the functions above.
Also updated the default value for the stdio option in the docs for the child_process.spawnSync function, to complete the picture.

Fixes: #49417

@nodejs-github-bot nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Sep 4, 2023
@atlowChemi
Copy link
Member

@nodejs/child_process

@atlowChemi atlowChemi added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Sep 6, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 6, 2023
@nodejs-github-bot nodejs-github-bot merged commit 6b135a1 into nodejs:main Sep 6, 2023
20 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 6b135a1

ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
PR-URL: #49481
Fixes: #49417
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
This was referenced Sep 28, 2023
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
PR-URL: nodejs#49481
Fixes: nodejs#49417
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: input option in child_process.spawnSync require stdio[0] to be pipe
5 participants