extra-exec v0.1.5

extra-exec

Install

npm install --save extra-exec
# or
yarn add extra-exec

API

class FailedError extends CustomError {
  readonly code: number
  readonly message: string
}

class KilledError extends CustomError {}

run

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function run(
  file: string
, args: string[]
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<void>

Please note that it runs without a shell.

evaluate

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function evaluate(
  file: string
, args: string[]
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    mergeStderrToStdout?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<string>

Please note that it runs without a shell.

Bash

run

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function run(
  command: string
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<void>

evaluate

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function evaluate(
  command: string
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    mergeStderrToStdout?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<string>

PowerShell

run

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function run(
  command: string
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<void>

evaluate

/**
 * @throws {FailedError}
 * @throws {KilledError}
 */
function evaluate(
  command: string
, options?: {
    interactive?: boolean = false
    mergeStdoutToStderr?: boolean = false
    mergeStderrToStdout?: boolean = false
    signal?: AbortSignal
    posixSignalOnAbort?: NodeJS.Signals
  }
): Promise<string>