Home > @rushstack/stream-collator > CollatedWriter

CollatedWriter class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

An writable interface for managing output of simultaneous processes.

Signature:

export declare class CollatedWriter extends TerminalWritable 

Extends: TerminalWritable

Constructors

Constructor	Modifiers	Description
(constructor)(taskName, collator)		(BETA) Constructs a new instance of the CollatedWriter class

Properties

Property	Modifiers	Type	Description
bufferedChunks	readonly	ReadonlyArray<ITerminalChunk>	(BETA) For diagnostic purposes, if the writer is buffering chunks because it has not become active yet, they can be inspected via this property.
isActive	readonly	boolean	(BETA) Returns true if this is the active writer for its associated StreamCollator.
taskName	readonly	string	(BETA)
terminal	readonly	CollatedTerminal	(BETA)

Methods

Method	Modifiers	Description
onClose()		(BETA) Subclasses can override this empty method to perform additional operations such as closing a file handle.
onWriteChunk(chunk)		(BETA) Subclasses should implement this abstract method to process the chunk.