footprintjs - v11.2.0
    Preparing search index...

    Interface ScopeRecorder

    Pluggable observer for scope operations.

    All methods are optional — implement only the hooks you need. Recorders are invoked synchronously in attachment order. If a recorder throws, the error is caught and passed to onError hooks of other recorders; the scope operation continues normally.

    interface ScopeRecorder {
        id: string;
        clear?(): void;
        onCommit?(event: CommitEvent): void;
        onEmit?(event: EmitEvent): void;
        onError?(event: ErrorEvent): void;
        onPause?(event: PauseEvent): void;
        onRead?(event: ReadEvent): void;
        onResume?(event: ResumeEvent): void;
        onStageEnd?(event: StageEvent): void;
        onStageStart?(event: StageEvent): void;
        onWrite?(event: WriteEvent): void;
        toSnapshot?(): RecorderBundle;
    }

    Implemented by

    Index
    id
    clear? onCommit? onEmit? onError? onPause? onRead? onResume? onStageEnd? onStageStart? onWrite? toSnapshot?
    id: string

    • Reset state before each executor.run() — prevents cross-run accumulation.

      Returns void

    • Fires for every scope.$emit(name, payload) call during a stage. Optional — implement only if you want to observe consumer-emitted structured events. See EmitRecorder for the focused interface (structurally compatible; this field is the same shape).

      Parameters

      Returns void

      EmitRecorder in src/lib/recorder/EmitRecorder.ts

    • Parameters

      • event: PauseEvent

      Returns void

    • Parameters

      • event: ResumeEvent

      Returns void

    • Expose collected data for inclusion in executor.getSnapshot().recorders.

      Returns RecorderBundle

    Settings
    Member Visibility

    On This Page
    Properties
    Methods