Documentation / listr2 / ProcessOutput
Class: ProcessOutput
Defined in: packages/listr2/src/utils/process-output/process-output.ts:15
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
Constructor
new ProcessOutput(
stdout?,stderr?,options?):ProcessOutput
Defined in: packages/listr2/src/utils/process-output/process-output.ts:19
Parameters
stdout?
WriteStream
stderr?
WriteStream
options?
Returns
ProcessOutput
Properties
stream
readonlystream:ProcessOutputStreamMap
Defined in: packages/listr2/src/utils/process-output/process-output.ts:16
active
protectedactive:boolean
Defined in: packages/listr2/src/utils/process-output/process-output.ts:17
Accessors
stdout
Get Signature
get stdout():
WriteStream
Defined in: packages/listr2/src/utils/process-output/process-output.ts:36
Returns
WriteStream
stderr
Get Signature
get stderr():
WriteStream
Defined in: packages/listr2/src/utils/process-output/process-output.ts:40
Returns
WriteStream
Methods
hijack()
hijack():
void
Defined in: packages/listr2/src/utils/process-output/process-output.ts:44
Returns
void
release()
release():
void
Defined in: packages/listr2/src/utils/process-output/process-output.ts:54
Returns
void
toStdout()
toStdout(
buffer,eol?):boolean
Defined in: packages/listr2/src/utils/process-output/process-output.ts:88
Parameters
buffer
string
eol?
boolean = true
Returns
boolean
toStderr()
toStderr(
buffer,eol?):boolean
Defined in: packages/listr2/src/utils/process-output/process-output.ts:96
Parameters
buffer
string
eol?
boolean = true
Returns
boolean