Skip to content

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

Source

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

Properties

stream

readonly stream: ProcessOutputStreamMap

Source

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


active

protected active: boolean

Source

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


options?

private optional readonly options: ProcessOutputOptions

Source

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

Accessors

stdout

get stdout(): WriteStream

Returns

WriteStream

Source

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


stderr

get stderr(): WriteStream

Returns

WriteStream

Source

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

Methods

hijack()

hijack(): void

Returns

void

Source

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


release()

release(): void

Returns

void

Source

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


toStdout()

toStdout(buffer, eol): boolean

Parameters

buffer: string

eol: boolean= true

Returns

boolean

Source

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


toStderr()

toStderr(buffer, eol): boolean

Parameters

buffer: string

eol: boolean= true

Returns

boolean

Source

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