RoadmapShopEvents
Skip to main content

Home > @rushstack/terminal > TextRewriterTransform

TextRewriterTransform class

A TerminalTransform subclass that performs one or more TextRewriter operations. The most common operations are NormalizeNewlinesTextRewriter and RemoveColorsTextRewriter.

Signature:

export declare class TextRewriterTransform extends TerminalTransform 

Extends: TerminalTransform

Remarks

The TextRewriter operations are applied separately to the stderr and stdout streams. If multiple ITextRewriterTransformOptions.textRewriters are configured, they are applied in the order that they appear in the array.

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the TextRewriterTransform class

Properties

PropertyModifiersTypeDescription
textRewritersreadonlyReadonlyArray<TextRewriter>

Methods

MethodModifiersDescription
onClose()protected
onWriteChunk(chunk)protected