Class CliProcessHandler

Hierarchy

CliProcessHandler

Implements

ProcessHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CliProcessHandler(childProcess: ChildProcess, statsFilePath?: string): CliProcessHandler

- Defined in packages/jbr/lib/process/CliProcessHandler.ts:15
Parameters
- childProcess: ChildProcess
- Optional statsFilePath: string
Returns CliProcessHandler

Properties

Readonly childProcess

childProcess: ChildProcess

ended

ended: boolean

Optional errored

errored: Error

Optional Readonly statsFilePath

statsFilePath: string

Readonly terminationHandlers

terminationHandlers: Set<(processName: string, error?: Error) => void>

Methods

addTerminationHandler

addTerminationHandler(handler: (processName: string, error?: Error) => void): void

Implementation of ProcessHandler.addTerminationHandler
- Defined in packages/jbr/lib/process/CliProcessHandler.ts:109
Register a termination handler.

Parameters
- handler: (processName: string, error?: Error) => void
  - - (processName: string, error?: Error): void
    - Parameters
      - processName: string
      - Optional error: Error
      Returns void
Returns void

close

close(): Promise<void>

Implementation of ProcessHandler.close
- Defined in packages/jbr/lib/process/CliProcessHandler.ts:40
Stop and clean this process.

Returns Promise<void>

join

join(): Promise<void>

Implementation of ProcessHandler.join
- Defined in packages/jbr/lib/process/CliProcessHandler.ts:68
Wait until this container is ended.

Returns Promise<void>

Protected onTerminated

onTerminated(error?: Error): void

- Defined in packages/jbr/lib/process/CliProcessHandler.ts:117
Parameters
- Optional error: Error
Returns void

removeTerminationHandler

removeTerminationHandler(handler: (processName: string, error?: Error) => void): void

Implementation of ProcessHandler.removeTerminationHandler
- Defined in packages/jbr/lib/process/CliProcessHandler.ts:113
Remove a termination listener.

Parameters
- handler: (processName: string, error?: Error) => void
  - - (processName: string, error?: Error): void
    - Parameters
      - processName: string
      - Optional error: Error
      Returns void
Returns void

startCollectingStats

startCollectingStats(): Promise<() => void>

Implementation of ProcessHandler.startCollectingStats
- Defined in packages/jbr/lib/process/CliProcessHandler.ts:81
Start collecting runtime statistics into the target stats file. The returned callback is used to end stat collection.

Returns Promise<() => void>

Generated using TypeDoc