diff options
Diffstat (limited to 'desktop/node_modules/@malept/cross-spawn-promise/README.md')
| -rw-r--r-- | desktop/node_modules/@malept/cross-spawn-promise/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/desktop/node_modules/@malept/cross-spawn-promise/README.md b/desktop/node_modules/@malept/cross-spawn-promise/README.md new file mode 100644 index 0000000..82d4cdb --- /dev/null +++ b/desktop/node_modules/@malept/cross-spawn-promise/README.md @@ -0,0 +1,27 @@ +# `@malept/cross-spawn-promise` + +> A promisified version of [`cross-spawn`](https://npm.im/cross-spawn) with slightly different behavior & extra options. + +[](https://github.com/malept/cross-spawn-promise/actions?query=workflow%3ACI) +[](https://www.npmjs.com/package/@malept/cross-spawn-promise) +[](https://codecov.io/gh/malept/cross-spawn-promise) + +## Different Behavior + +If the spawned process exits with a non-zero code, an `ExitCodeError` is thrown with the original +command, code, `stdout`, and `stderr` as properties. + +If the spawned process is terminated by a signal on non-Windows platforms, an `ExitSignalError` is +thrown with the original command, signal name, `stdout`, and `stderr` as properties. + +## Extra Options + +- `logger`: a `Function` such as `console.log` or `debug(name)` to log some information + about the spawned process. +- `updateErrorCallback`: a callback which mutates the error before it is re-thrown. Most commonly, + this is used to augment the error message of `ENOENT` error to provide a more human-friendly + message as to how to install the missing executable. + +## Legal + +This module is licensed under the Apache 2.0 license. |