Separate core options from execa-specific options #256
Conversation
readme.md
Outdated
| @@ -250,6 +309,24 @@ Default: `true` | |||
|
|
|||
| Set to `false` if you don't want to extend the environment variables when providing the `env` property. | |||
|
|
|||
| ### options from child_process#spawn and child_process#exec | |||
There was a problem hiding this comment.
Feels weird to have a heading here. It kinda makes it unclear how to use these options. I would rather have it like this:
---
Execa also accepts the below options which are passed directly to `child_process#spawn()`/`child_process#exec()`
---
There was a problem hiding this comment.
child_process#exec()
We don't actually use exec() internally, so not sure why it's mentioned here.
There was a problem hiding this comment.
We don't use it, but we re-implement its options (timeout, maxBuffer, killSignal).
From a user perspective, it does not matter whether we use spawn() or exec() internally. Instead, what a user sees is that options from both spawn() and exec() work.
There was a problem hiding this comment.
Ok. I still think we should make that clearer, with something like a proposed above.
|
Fixed. :) |
readme.md
Outdated
|
|
||
| The same options as both [`child_process#spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) and [`child_process#exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) can also be used. | ||
| Execa also accepts the below options which are passed directly to [`child_process#spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)/[`child_process#exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) |
There was a problem hiding this comment.
Hmm. I still don't like the wording.
Execa also accepts the below options which are the same as the options for
child_process#spawn()/child_process#exec()
?
readme.md
Outdated
| @@ -311,7 +311,7 @@ Set to `false` if you don't want to extend the environment variables when provid | |||
|
|
|||
| --- | |||
|
|
|||
| Execa also accepts the below options which are passed directly to [`child_process#spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)/[`child_process#exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) | |||
| Execa also accepts the below options which are the same options for [`child_process#spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)/[`child_process#exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) | |||
There was a problem hiding this comment.
This is not exactly what I wrote.
Fixes #252
I've also re-ordered the options in
index.test-d.tsandindex.d.tsaccordingly.