Home > @rushstack/stream-collator > IStreamCollatorOptions > onWriterActive

IStreamCollatorOptions.onWriterActive property

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

An event handler that is called when a CollatedWriter becomes output, before any of its chunks have been written to the destination.

Signature:

onWriterActive?: (writer: CollatedWriter) => void;

Remarks

Each CollatedWriter object will become active exactly once before the StreamCollator completes.