footprintjs - v11.2.0
    Preparing search index...

    Type Alias CombinedRecorder

    CombinedRecorder: Partial<
        Omit<ScopeRecorder, SharedLifecycleOverlap | SharedLifecycle>,
    > & Partial<Omit<FlowRecorder, SharedLifecycleOverlap | SharedLifecycle>> & Partial<
        Omit<EmitRecorder, SharedLifecycle>,
    > & {
        delivery?: "inline" | "deferred";
        id: string;
        clear?(): void;
        onError?(event: ErrorEvent | FlowErrorEvent): void;
        onPause?(event: PauseEvent | FlowPauseEvent): void;
        onResume?(event: ResumeEvent | FlowResumeEvent): void;
        toSnapshot?(): RecorderBundle;
    }

    A recorder that MAY observe any combination of supported event streams.

    Today's streams:

    • Scope data-flow (ScopeRecorder: onRead/onWrite/onCommit/onStageStart/…)
    • Control-flow (FlowRecorder: onDecision/onSubflowEntry/onLoop/…)
    • Emit (EmitRecorder: onEmit)

    All event handlers are optional — implement only what you care about. id is required so the library can deduplicate re-attaches.

    Shared method names (onError / onPause / onResume)

    Both ScopeRecorder and FlowRecorder declare these with DIFFERENT payload shapes. In a combined recorder, each such handler is called by BOTH channels with its own variant. The parameter type is a union — consumers can either handle both variants uniformly, or discriminate with isFlowEvent() (explicit channel discriminant stamped by the engine).

    When another observer type ships (e.g. OperationRecorder), the type gains another & Partial<…> clause. Because every clause is Partial, existing CombinedRecorder implementations remain type-valid.

    Type Declaration

    • Optional Readonlydelivery?: "inline" | "deferred"

      Delivery tier for this recorder (RFC-001) — the FIELD form of the attachCombinedRecorder(r, { delivery }) options bag, so a recorder can DECLARE its tier ({ id, delivery: 'deferred', ...hooks }) and every attach site honors it. 'deferred' routes the recorder's events through the executor's bounded capture queue ("one beat behind"); absent / 'inline' keeps the historical synchronous call. NOT an event method — channel routing detection counts event-METHOD properties only, so this string field never affects which channels the recorder lands on.

    • Readonlyid: string
    • clear?: function
    • onError?: function
    • onPause?: function
    • onResume?: function
    • toSnapshot?: function

    Settings
    Member Visibility

    On This Page
    Shared method names (onError / onPause / onResume)Forward compatibility