Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Const exec

  • exec(command: string, __namedParameters?: ExecOptions & { encoding?: BufferEncoding; log?: boolean }): Promise<string>
  • Parameters

    • command: string
    • __namedParameters: ExecOptions & { encoding?: BufferEncoding; log?: boolean } = {}

    Returns Promise<string>

promisifyChildProcess

  • promisifyChildProcess<TArgs, TReturn, T>(fn: T): (...args: TArgs) => Promise<string> & TReturn
  • promisifyChildProcess<T>(child: T): Promise<string> & T
  • Takes in a function that returns a child process, and returns a function that returns an object that combines that same child process with a promise that resolves to the string value of stdout when that process exits.

    Type parameters

    • TArgs: any[]

    • TReturn: ChildProcess<TReturn>

    • T: (...args: TArgs) => TReturn

    Parameters

    • fn: T

    Returns (...args: TArgs) => Promise<string> & TReturn

      • (...args: TArgs): Promise<string> & TReturn
      • Takes in a function that returns a child process, and returns a function that returns an object that combines that same child process with a promise that resolves to the string value of stdout when that process exits.

        Parameters

        • Rest ...args: TArgs

        Returns Promise<string> & TReturn

  • Takes in a a child process, and returns an object that combines that same child process with a promise that resolves to the string value of stdout when that process exits.

    Type parameters

    • T: ChildProcess<T>

    Parameters

    • child: T

    Returns Promise<string> & T

spawn

  • spawn(command: string, args?: string[], options?: SpawnOptions): Promise<string> & ChildProcess
  • spawn(command: string, options?: SpawnOptions): Promise<string> & ChildProcess
  • Returns a ChildProcess that can be await-ed

    Parameters

    • command: string
    • Optional args: string[]
    • Optional options: SpawnOptions

    Returns Promise<string> & ChildProcess

  • Returns a ChildProcess that can be await-ed

    Parameters

    • command: string
    • Optional options: SpawnOptions

    Returns Promise<string> & ChildProcess

Generated using TypeDoc