monitor-api - v1.8.0
    Preparing search index...

    Interface IPerformanceCollector

    Public API exposed by the performance collector.

    interface IPerformanceCollector {
        cls: SSignal<number>;
        fps: SSignal<number>;
        fpsHistory: SSignal<number[]>;
        longAnimationFrames: SSignal<LongAnimationFrameInfo>;
        longTasks: SSignal<LongTaskInfo>;
        memory: SSignal<MemoryInfo | null>;
        memoryHistory: SSignal<number[]>;
        memoryMeasurement: SSignal<MemoryMeasurement | null>;
        snapshot: SSignal<PerformanceSnapshot>;
        clearHistory(): void;
        destroy(): void;
        start(): void;
        stop(): void;
    }
    Index

    Properties

    cls fps fpsHistory longAnimationFrames longTasks memory memoryHistory memoryMeasurement snapshot

    Methods

    clearHistory destroy start stop

    Properties

    cls: SSignal<number>

    Signal containing cumulative layout shift.

    fps: SSignal<number>

    Signal containing the latest FPS value.

    fpsHistory: SSignal<number[]>

    Signal containing retained FPS history.

    longAnimationFrames: SSignal<LongAnimationFrameInfo>

    Signal containing long animation frame counters and recent frames.

    longTasks: SSignal<LongTaskInfo>

    Signal containing long task summary information.

    memory: SSignal<MemoryInfo | null>

    Signal containing current memory information, or null when unavailable.

    memoryHistory: SSignal<number[]>

    Signal containing retained memory percentage history.

    memoryMeasurement: SSignal<MemoryMeasurement | null>

    Signal containing the latest page memory measurement, or null when unavailable.

    snapshot: SSignal<PerformanceSnapshot>

    Signal containing the complete performance snapshot.

    Methods

    • Clears retained FPS and memory histories and recent long animation frames, without resetting current metric values or counters.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods