listr2

Appearance

Documentation / listr2 / ProcessOutput

Class: ProcessOutput ​

Creates a new Listr2 process-output controller.

This is used to control the flow to process.stdout and process.stderr for all renderers.

See ​

https://listr2.kilic.dev/renderer/process-output.html

Constructors ​

new ProcessOutput() ​

new ProcessOutput(stdout?, stderr?, options?): ProcessOutput

Parameters ​

• stdout?: WriteStream

• stderr?: WriteStream

• options?: ProcessOutputOptions

Returns ​

ProcessOutput

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:19

Properties ​

stream ​

readonly stream: ProcessOutputStreamMap

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:16

active ​

protected active: boolean

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:17

Accessors ​

stdout ​

get stdout(): WriteStream

Returns ​

WriteStream

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:36

stderr ​

get stderr(): WriteStream

Returns ​

WriteStream

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:40

Methods ​

hijack() ​

hijack(): void

Returns ​

void

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:44

release() ​

release(): void

Returns ​

void

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:54

toStdout() ​

toStdout(buffer, eol): boolean

Parameters ​

• buffer: string

• eol: boolean = true

Returns ​

boolean

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:88

toStderr() ​

toStderr(buffer, eol): boolean

Parameters ​

• buffer: string

• eol: boolean = true

Returns ​

boolean

Defined in ​

packages/listr2/src/utils/process-output/process-output.ts:96