RoadmapShopEvents
Skip to main content

Home > @rushstack/terminal > ITextRewriterTransformOptions

ITextRewriterTransformOptions interface

Constructor options for TextRewriterTransform.

Signature:

export interface ITextRewriterTransformOptions extends ITerminalTransformOptions 

Extends: ITerminalTransformOptions

Properties

PropertyModifiersTypeDescription
destinationTerminalWritable

The target TerminalWritable that the TerminalTransform will write its output to.

(Inherited from ITerminalTransformOptions)

ensureNewlineAtEnd?boolean(Optional) If normalizeNewlines or ensureNewlineAtEnd is specified, a NormalizeNewlinesTextRewriter will be appended to the list of rewriters with the specified settings.
normalizeNewlines?NewlineKind(Optional) If normalizeNewlines or ensureNewlineAtEnd is specified, a NormalizeNewlinesTextRewriter will be appended to the list of rewriters with the specified settings.
preventAutoclose?boolean

(Optional) When this object is the TerminalTransform.destination for a transform, the transform will automatically close this object. Set preventAutoclose to true to prevent that behavior.

(Inherited from ITerminalWritableOptions)

preventDestinationAutoclose?boolean

(Optional) Prevents the TerminalTransform.destination object from being closed automatically when the transform is closed.

(Inherited from ITerminalTransformOptions)

removeColors?boolean(Optional) If specified, a RemoveColorsTextRewriter will be appended to the list of rewriters.
textRewriters?TextRewriter[](Optional) A list of rewriters to be applied. More items may be appended to the list, for example if ITextRewriterTransformOptions.removeColors is specified.