package
Promise-based child process interface
npm install async-child-processGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 4 packages.
1.3 MB
Includes dependencies.
A simple Promise-based API for working with ChildProcesses.
npm install --save async-child-processjoin(child: ChildProcess): Promise<Result>Waits for child to exit.
Returns a Promise that:
{code: 0} if child exits with code 0error.code will be the exit code if the child exited normallyerror.signal will be the signal the child was terminated with, if anychild emits an error, it may be the rejection reason and it may not have code or signalExample:
import {exec} from 'child_process'
import {join} from 'async-child-process'
async function test() {
await join(exec('echo hello world'))
}kill(child: ChildProcess, signal?: string): Promise<void>Sends a signal to child and waits for it to exit.
Returns a Promise that:
child is killederror if child emits oneExample:
import {exec} from 'child_process'
import {kill} from 'async-child-process'
async function test() {
const child = exec(`node -e 'setTimeout(() => console.log("finally!"), 1e11)'`)
await kill(child)
}childPrinted(child: ChildProcess, predicate: (output: string) => boolean | RegExp, stream?: 'stdout' | 'stderr'): Promise<string>Waits for child to print something to its stdout and/or stderr. Returns a promise that:
predicate orchild exited or errored before printing a message that matched predicateArguments:
ChildProcess to listen tochildPrinted will wait until child's stream(s) output a message matching the predicatechild's streams to listen to, omit to listen to both stdout and stderrExample:
import {exec} from 'child_process'
import {childPrinted} from 'async-child-process'
async function test() {
const child = exec(`webpack --config webpack.config.dev.js`)
await childPrinted(child, /webpack built in \d+ ms/)
}execAsync(command: string, options?: Object): Promise<Result>Like exec, but returns a Promise that:
{stdout: string, stderr: string} from running command if it exited with code 0error.code will be the exit code if the child exited normallyerror.signal will be the signal the child was terminated with, if anychild emits an error, it may be the rejection reason and it may not have code or signalExample:
import {execAsync} from 'async-child-process'
async function test() {
const {stdout} = await execAsync('docker-compose port webapp 80')
const testUrl = stdout.trim()
}