Home > @rushstack/stream-collator > StreamCollator

StreamCollator 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.

A static class which manages the output of multiple threads.

Signature:

export declare class StreamCollator 

Constructors

Constructor	Modifiers	Description
(constructor)(options)		(BETA) Constructs a new instance of the StreamCollator class

Properties

Property	Modifiers	Type	Description
activeTaskName	readonly	string	(BETA) For diagnostic purposes, returns the CollatedWriter.taskName for the currently active writer, or an empty string if no writer is active.
activeWriter	readonly	CollatedWriter | undefined	(BETA) Returns the currently active CollatedWriter, or undefined if no writer is active yet.
destination	readonly	TerminalWritable	(BETA)
terminal	readonly	CollatedTerminal	(BETA)
writers	readonly	ReadonlySet<CollatedWriter>	(BETA) The list of writers that have been registered by calling StreamCollator.registerTask(), in the order that they were registered.

Methods

Method	Modifiers	Description
registerTask(taskName)		(BETA) Registers a new task to be collated, and constructs a CollatedWriter object to receive its input.