# cross-spawn-promise

> Promisified cross-spawn.

Latest version **0.10.2** (published 2020-01-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install cross-spawn-promise
pnpm add cross-spawn-promise
yarn add cross-spawn-promise
bun add cross-spawn-promise
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.2 |
| Published | 2020-01-31 |
| First published | 2016-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Zentrick nv |
| Maintainers | delbeke, timdp |

## Links

- npm: https://www.npmjs.com/package/cross-spawn-promise
- Repository: https://github.com/zentrick/cross-spawn-promise
- Homepage: https://github.com/zentrick/cross-spawn-promise#readme
- Issues: https://github.com/zentrick/cross-spawn-promise/issues
- npm.io page: https://npm.io/package/cross-spawn-promise

## Dependencies (1)

- [cross-spawn](https://npm.io/package/cross-spawn.md) ^5.1.0

## Recent versions

- 0.10.2 (latest) — 2020-01-31
- 0.10.1 — 2017-03-29
- 0.10.0 — 2017-03-29
- 0.9.2 — 2017-02-02
- 0.9.1 — 2016-12-15
- 0.9.0 — 2016-11-23
- 0.8.0 — 2016-09-19
- 0.7.0 — 2016-09-05
- 0.6.0 — 2016-05-27
- 0.5.0 — 2016-05-21
- 0.4.1 — 2016-03-31
- 0.4.0 — 2016-03-31
- 0.3.0 — 2016-03-03
- 0.2.0 — 2016-03-03
- 0.1.0 — 2016-03-02

## README

# cross-spawn-promise

[![npm](https://img.shields.io/npm/v/cross-spawn-promise.svg)](https://www.npmjs.com/package/cross-spawn-promise) [![Dependencies](https://img.shields.io/david/zentrick/cross-spawn-promise.svg)](https://david-dm.org/zentrick/cross-spawn-promise) [![Linux Build Status](https://img.shields.io/circleci/project/github/zentrick/cross-spawn-promise/master.svg?label=linux+build)](https://circleci.com/gh/zentrick/cross-spawn-promise) [![Windows Build Status](https://img.shields.io/appveyor/ci/zentrick/cross-spawn-promise/master.svg?label=windows+build)](https://ci.appveyor.com/project/zentrick/cross-spawn-promise) [![Coverage Status](https://img.shields.io/coveralls/zentrick/cross-spawn-promise/master.svg)](https://coveralls.io/r/zentrick/cross-spawn-promise) [![JavaScript Standard Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

Promisified [cross-spawn](https://www.npmjs.com/package/cross-spawn).

## Usage

```js
import spawn from 'cross-spawn-promise'

const command = 'ls'
const args = ['-al', '/etc']
const options = {}
spawn(command, args, options)
  .then((stdout) => {
    console.info('Success!')
    console.info('stdout:', stdout.toString())
  })
  .catch((error) => {
    console.error('Failed!')
    console.error('exit status:', error.exitStatus)
    console.error('stderr:', error.stderr.toString())
  })
```

## API

```js
async spawn(command[, args][, options])
```

The returned `Promise` will resolve to the process's standard output. Depending
on the value of the `encoding` option (see below), it will either be a
[`Buffer`](https://nodejs.org/api/buffer.html) or a string.

The promise also exposes the created child process via its `childProcess`
property.

Upon rejection, the following properties provide additional information on the
`Error` object:

- `exitSignal`
- `exitStatus`
- `stdout`
- `stderr`

## Options

All options are passed on to
[cross-spawn](https://www.npmjs.com/package/cross-spawn), with the exception of
the additional `encoding` option. If you pass a string (e.g., `'utf8'`), it will
be used as the
[default character encoding](https://nodejs.org/api/stream.html#stream_readable_setencoding_encoding).

## Maintainer

[Tim De Pauw](https://github.com/timdp)

## License

MIT

---
_Source: https://npm.io/package/cross-spawn-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._