Home > @rushstack/terminal > SplitterTransform
SplitterTransform class
Use this instead of TerminalTransform if you need to output ITerminalChunk
data to more than one destination.
Signature:
export declare class SplitterTransform extends TerminalWritable
Extends: TerminalWritable
Remarks
Splitting streams complicates the pipeline topology and can make debugging more difficult. For this reason, it is modeled as an explicit SplitterTransform
node, rather than as a built-in feature of TerminalTransform
.
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(options) | Constructs a new instance of the SplitterTransform class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
destinations | readonly | ReadonlyArray<TerminalWritable> | |
isOpen | readonly | boolean | This property is initially (Inherited from TerminalWritable) |
preventAutoclose | readonly | boolean | (Inherited from TerminalWritable) |
Methods
Method | Modifiers | Description |
---|---|---|
close() | Calling this method flushes any remaining outputs and permanently transitions the (Inherited from TerminalWritable) | |
onClose() | protected | |
onWriteChunk(chunk) | protected | |
writeChunk(chunk) | Upstream objects call this method to provide inputs to this object. (Inherited from TerminalWritable) |