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

Jump to bottom

Separate child_process options from execa options in the README #252

Closed
ehmicky opened this issue May 15, 2019 · 2 comments · Fixed by #256
Closed

Separate child_process options from execa options in the README #252

ehmicky opened this issue May 15, 2019 · 2 comments · Fixed by #256

Comments

@ehmicky
Copy link
Collaborator

ehmicky commented May 15, 2019 •
edited

I think we should divide the Options section in the README in two parts:

  • first the options that are specific to execa.
  • then the options that we simply forward to child_process.spawn(). We can also add a sentence saying those are the same options as child_process.spawn().

This would help users that are already familiar with child_process.spawn() and only want to know which extra options execa brings.

We could also fix index.d.ts to follow the same division.

If you think that's a good idea, I can submit a PR.
@sindresorhus
Copy link
Owner

Good point. Makes sense. 👍

@ehmicky ehmicky mentioned this issue May 18, 2019
Merged
@ehmicky
Copy link
Collaborator Author

ehmicky commented May 18, 2019

Done at #256.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Separate core options from execa-specific options sindresorhus/execa
2 participants
@sindresorhus @ehmicky