Interface TraceRecorder

Collects finished trees in memory; stop() returns a Chrome trace

interface TraceRecorder {
    name?: string;
    roots: ExecutionRecord[];
    onComplete?(root: ExecutionRecord): void;
    onStart?(execution: ExecutionStart): void;
    stop(): ChromeTrace;
    wrap?<R>(execution: ExecutionStart, run: () => R): R;
}

Hierarchy (View Summary)

TracePerfPlugin
- TraceRecorder

Index

Properties

Methods

onComplete? onStart? stop wrap?

Properties

`Optional`name

name?: string

Optional name used in error messages

`Readonly`roots

roots: ExecutionRecord[]

Trees recorded so far

Methods

`Optional`onComplete

onComplete?(root: ExecutionRecord): void
A top-level call finished; root holds the whole tree
Parameters
- root: ExecutionRecord
Returns void
Inherited from TracePerfPlugin.onComplete
- Defined in core/records.ts:165

`Optional`onStart

onStart?(execution: ExecutionStart): void
A tracked call started (runs inside the caller's async context)
Parameters
- execution: ExecutionStart
Returns void
Inherited from TracePerfPlugin.onStart
- Defined in core/records.ts:163

stop

stop(): ChromeTrace
Stop recording and return the trace (also unsubscribes, when attached via startTrace)

Returns ChromeTrace
- Defined in core/exporters.ts:104

`Optional`wrap

wrap?<R>(execution: ExecutionStart, run: () => R): R
Run the tracked code inside something (e.g. an active OpenTelemetry span). Must call run exactly once and return its result.
Type Parameters
- R
Parameters
- execution: ExecutionStart
- run: () => R
Returns R
Inherited from TracePerfPlugin.wrap
- Defined in core/records.ts:170