Interface IReactCollector

Public API exposed by the React collector.

interface IReactCollector {
    onCommit: SSignal<RenderEntry | null>;
    snapshot: SSignal<ReactSnapshot>;
    clearLog(): void;
    destroy(): void;
    setSlowThreshold(ms: number): void;
    start(): void;
    stop(): void;
}

Index

Properties

onCommit snapshot

Methods

clearLog destroy setSlowThreshold start stop

Properties

onCommit

onCommit: SSignal<RenderEntry | null>

Signal set to the latest render entry, or null before any render is captured.

snapshot

snapshot: SSignal<ReactSnapshot>

Signal containing retained render history and derived statistics.

Methods

clearLog

clearLog(): void
Clears retained render entries, component statistics, and commit count.

Returns void
- Defined in core/types/react.ts:72

destroy

destroy(): void
Stops the collector and releases owned resources.

Returns void
- Defined in core/types/react.ts:78

setSlowThreshold

setSlowThreshold(ms: number): void
Updates the slow render threshold in milliseconds.
Parameters
- ms: number
Returns void
- Defined in core/types/react.ts:70

start

start(): void
Hooks into the React DevTools global hook when running in a browser.

Returns void
- Defined in core/types/react.ts:74

stop

stop(): void
Restores the previous React DevTools hook handler.

Returns void
- Defined in core/types/react.ts:76