FailureCollectorSink
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:48
Forwards every event to the wrapped sink unchanged, and additionally buffers
each "failed" scope; at close(), re-renders and re-writes them together
as a summary, so a failure doesn’t need to be found by scrolling back through
the rest of the run’s output.
Type Parameters
Section titled “Type Parameters”TData
Implements
Section titled “Implements”ISink<TData>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FailureCollectorSink<
TData>(sink,options):FailureCollectorSink<TData>
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:60
Parameters
Section titled “Parameters”ISink<TData>
options
Section titled “options”FailureCollectorSinkOptions<TData>
Returns
Section titled “Returns”FailureCollectorSink<TData>
Methods
Section titled “Methods”close()
Section titled “close()”close(
signal?):Promise<void>
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:121
Renders and writes the buffered failures as a summary, then closes the wrapped sink.
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”enabled()
Section titled “enabled()”enabled(
probe):boolean
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:69
Fast path: veto before the emitter allocates the event. Default: always enabled.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”flush()
Section titled “flush()”flush(
signal?):void|Promise<void>
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:113
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”write()
Section titled “write()”write(
event,signal?):Promise<void>
Defined in: packages/app-report/src/sink/failure-collector-sink.ts:73
Parameters
Section titled “Parameters”ReportEvent<TData>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>