Interface ChildProcessOnProject

Convenience access to running child processes in the context of a local project

Hierarchy

ChildProcessOnProject

Index

Methods

exec
spawn

Methods

exec

exec(cmd: string, args?: string | string[], opts?: SpawnSyncOptions): Promise<ExecPromiseResult>

- Defined in lib/api-helper/project/withProject.ts:64
Spawn a child process, by default setting cwd to the directory of the local project. Any cwd passed in the options overrides the default. See [[execPromise]] for more details.

Parameters
- cmd: string
  
  Command to spawn
- Optional args: string | string[]
  
  Arguments to command
- Optional opts: SpawnSyncOptions
  
  Spawn options
Returns Promise<ExecPromiseResult>

Command standard output and standard error

spawn

spawn(cmd: string, args?: string | string[], opts?: Partial<SpawnLogOptions>): Promise<SpawnLogResult>

- Defined in lib/api-helper/project/withProject.ts:52
Spawn a child process, by default setting cwd to the directory of the local project and using the progressLog of GoalInvocation as logger. Any cwd passed in the options overrides the default. See spawnLog for more details.

Parameters
- cmd: string
  
  Command to spawn
- Optional args: string | string[]
  
  Arguments to command
- Optional opts: Partial<SpawnLogOptions>
  
  Spawn options
Returns Promise<SpawnLogResult>

Command result

Generated using TypeDoc