Interface IWebVitalsCollector

Public API exposed by the Web Vitals collector.

interface IWebVitalsCollector {
    onMetric: SSignal<WebVitalMetric | null>;
    snapshot: SSignal<WebVitalsSnapshot>;
    clearLog(): void;
    destroy(): void;
    start(): void;
    stop(): void;
}

Index

Properties

onMetric snapshot

Methods

clearLog destroy start stop

Properties

onMetric

onMetric: SSignal<WebVitalMetric | null>

Signal set to the latest Web Vitals metric report, or null before any metric is reported.

snapshot

snapshot: SSignal<WebVitalsSnapshot>

Signal containing latest Web Vitals values and retained reports.

Methods

clearLog

clearLog(): void
Clears retained metric reports and latest values.

Returns void
- Defined in core/types/webVitals.ts:55

destroy

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

Returns void
- Defined in core/types/webVitals.ts:61

start

start(): void
Starts Web Vitals observers when running in a browser.

Returns void
- Defined in core/types/webVitals.ts:57

stop

stop(): void
Stops accepting future Web Vitals reports from registered callbacks.

Returns void
- Defined in core/types/webVitals.ts:59