Home > @rushstack/terminal > ProblemCollector

ProblemCollector class

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

A TerminalWritable that consumes line-oriented terminal output and extracts structured problems using one or more IProblemMatcher instances.

Signature:

export declare class ProblemCollector extends TerminalWritable implements IProblemCollector 

Extends: TerminalWritable

Implements: IProblemCollector

Remarks

This collector expects that each incoming ITerminalChunk represents a single line terminated by a "\n" character (for example when preceded by StderrLineTransform / StdioLineTransform). If a chunk does not end with a newline an error is thrown to surface incorrect pipeline wiring early.

Constructors

Constructor	Modifiers	Description
(constructor)(options)		(BETA) Constructs a new instance of the ProblemCollector class

Properties

Property	Modifiers	Type	Description
problems	readonly	ReadonlySet<IProblem>	(BETA) Collects problems (errors/warnings/info) encountered during an operation.

Methods

Method	Modifiers	Description
onClose()	protected	(BETA) The abstract base class for objects that can present, route, or process text output for a console application. This output is typically prepared using the Terminal API.
onWriteChunk(chunk)	protected	(BETA) The abstract base class for objects that can present, route, or process text output for a console application. This output is typically prepared using the Terminal API.