Class Process

Hierarchy-Diagram

UML class diagram of Process

Legend

icon for a class in the UML class diagram

class

icon for a public property in the UML class diagram

public property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

Hierarchy (view full)

ProcessBase
- Process

Index

Constructors

Properties

command server spawnHandle?

Methods

close execute getName prefixMessage terminate toString wait write

Constructors

constructor

new Process(server: Server, command: Command, defer?: boolean): Process
Parameters
- server: Server
- command: Command
- Optional defer: boolean
Returns Process
Overrides ProcessBase.constructor
- Defined in houston-common-lib/lib/process.ts:133

Properties

`Readonly` command

command: Command

`Readonly` server

server: Server

`Private` `Optional` spawnHandle

spawnHandle?: Spawn<Uint8Array>

Methods

close

close(): Process
Returns Process
- Defined in houston-common-lib/lib/process.ts:224

execute

execute(): Process
Returns Process
- Defined in houston-common-lib/lib/process.ts:141

getName

getName(): string
Returns string
Inherited from ProcessBase.getName
- Defined in houston-common-lib/lib/process.ts:64

prefixMessage

prefixMessage(message: string): string
Parameters
- message: string
Returns string
Inherited from ProcessBase.prefixMessage
- Defined in houston-common-lib/lib/process.ts:56

terminate

terminate(): Process
Returns Process
- Defined in houston-common-lib/lib/process.ts:217

toString

toString(): string
Returns string
Inherited from ProcessBase.toString
- Defined in houston-common-lib/lib/process.ts:68

wait

wait(failIfNonZero?: boolean): neverthrow.ResultAsync<ExitedProcess, ProcessError>
Parameters
- failIfNonZero: boolean = true
Returns neverthrow.ResultAsync<ExitedProcess, ProcessError>
- Defined in houston-common-lib/lib/process.ts:149

write

write(data: string | Uint8Array, stream?: boolean): neverthrow.Result<null, ProcessError>
Parameters
- data: string | Uint8Array
- stream: boolean = false
Returns neverthrow.Result<null, ProcessError>
- Defined in houston-common-lib/lib/process.ts:206