Interface ExecaChildPromise<StdoutErrorType>

interface ExecaChildPromise<StdoutErrorType> {
    all?: Readable;
    cancel(): void;
    catch<ResultType>(onRejected?: ((reason: ExecaError<StdoutErrorType>) => ResultType | PromiseLike<ResultType>)): Promise<ResultType | ExecaReturnValue<StdoutErrorType>>;
    kill(signal?: string, options?: KillOptions): void;
}

Type Parameters

  • StdoutErrorType

Properties

all?

Methods

cancel catch kill

Properties

Optionalall

all?: Readable

Stream combining/interleaving stdout and stderr.

This is undefined if either: - the all option is false (the default value) - both stdout and stderr options are set to 'inherit', 'ipc', Stream or integer

Methods

cancel

  • cancel(): void

  • Similar to childProcess.kill(). This is preferred when cancelling the child process execution as the error is more descriptive and childProcessResult.isCanceled is set to true.

    Returns void

catch

kill

  • kill(signal?, options?): void

  • Same as the original child_process#kill(), except if signal is SIGTERM (the default value) and the child process is not terminated after 5 seconds, force it by sending SIGKILL.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods