https://github.com/malept/cross-spawn-promise

A promisified version of cross-spawn with slightly different behavior & extra options.
https://github.com/malept/cross-spawn-promise

Last synced: 11 days ago
JSON representation

A promisified version of cross-spawn with slightly different behavior & extra options.

• Host: GitHub
• URL: https://github.com/malept/cross-spawn-promise
• Owner: malept
• License: apache-2.0
• Created: 2020-02-04T01:32:53.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-03T23:58:39.000Z (over 1 year ago)
• Last Synced: 2024-10-24T16:08:54.630Z (14 days ago)
• Language: TypeScript
• Homepage: https://npm.im/@malept/cross-spawn-promise
• Size: 326 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `@malept/cross-spawn-promise`

> A promisified version of [`cross-spawn`](https://npm.im/cross-spawn) with slightly different behavior & extra options.

[![CI](https://github.com/malept/cross-spawn-promise/workflows/CI/badge.svg)](https://github.com/malept/cross-spawn-promise/actions?query=workflow%3ACI)

[![NPM package](https://img.shields.io/npm/v/@malept/cross-spawn-promise.svg)](https://www.npmjs.com/package/@malept/cross-spawn-promise)

[![codecov](https://codecov.io/gh/malept/cross-spawn-promise/branch/main/graph/badge.svg)](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.