Home > @rushstack/stream-collator > IStreamCollatorOptions

IStreamCollatorOptions interface

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.

Constructor options for StreamCollator.

Signature:

export interface IStreamCollatorOptions 

Properties

Property	Modifiers	Type	Description
destination		TerminalWritable	(BETA) The target TerminalWritable object that the StreamCollator will write its output to.
onWriterActive?		(writer: CollatedWriter) => void	(BETA) (Optional) An event handler that is called when a CollatedWriter becomes output, before any of its chunks have been written to the destination.