@rushstack/stream-collator
Advanced tools
Display intelligible realtime output from concurrent processes
This library enables a tool to display live console output from multiple concurrent processes, while ensuring that their output does not get jumbled together.
The stream-collator manages the output of these streams, ensuring that no two streams are writing to the console at the same time. At any given time, one stream registered with the collator is the active stream, which means that particular stream will be live streaming, while the others will wait for that stream to finish before their output is displayed.
For example, if you have 3 streams (e.g. from using child_process.spawn()).
Stream A will write: AAAAA
Stream B will write: BBBBBBBBBBBBBBBBBBBB
Stream C will write: CCCCCCCCCC
If these streams are all being piped directly to stdout (without @rushstack/stream-collator), you could end up
with jumbled output:
ABACCCBCCCCBBABBCBBABBBBBBCCAB
Something like the following would be much more useful to users of your application:
AAAAABBBBBBBBBBBBBBBCCCCCCCCCC
This is where the @rushstack/stream-collator comes in!
At any given time, a single stream is designated as the active stream. The output of the active stream will always be live-streamed. This is particularly useful for long-running streams. When the active stream finishes, a new stream is selected as the active stream and all of its contents up to that point will be emitted. Whenever an active stream finishes, all background streams which have been completed will be emitted.
🚨 This is an early preview release. Please report issues! 🚨
WITH VERSION 4.X, THIS PACKAGE HAS BEEN REDESIGNED TO USE THE NEW @rushstack/terminal SYSTEM. IN THE NEXT RELEASE, THE
CollatedTerminalAPI WILL BE REPLACED WITH THETerminalAPI.The usage instructions will be updated once that refactoring is complete.
@rushstack/stream-collator is part of the Rush Stack family of projects.
The 'merge-stream' package allows you to merge multiple streams into a single stream. Unlike @rushstack/stream-collator, it does not provide advanced features for managing the interleaving of output or handling stream completion and errors in a coordinated manner.
The 'multistream' package allows you to combine multiple streams into a single stream. It focuses on sequentially combining streams rather than interleaving their output. It is simpler but less powerful compared to @rushstack/stream-collator.
The 'stream-combiner2' package allows you to combine multiple streams into a pipeline. It is useful for creating complex stream processing pipelines but does not provide the same level of control over output interleaving and stream management as @rushstack/stream-collator.
FAQs
Display intelligible realtime output from concurrent processes
We found that @rushstack/stream-collator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now scans OpenVSX extensions, giving teams early detection of risky behaviors, hidden capabilities, and supply chain threats in developer tools.
Product
Bringing supply chain security to the next generation of JavaScript package managers
Product
A safer, faster way to eliminate vulnerabilities without updating dependencies
