ScopeRecorder
Interface: ScopeRecorder
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:114
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.
Properties
id
readonlyid:string
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:115
Methods
clear()?
optionalclear():void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:134
Reset state before each executor.run() — prevents cross-run accumulation.
Returns
void
onCommit()?
optionalonCommit(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:118
Parameters
event
Returns
void
onEmit()?
optionalonEmit(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:132
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
event
Returns
void
See
EmitRecorder in src/lib/recorder/EmitRecorder.ts
onError()?
optionalonError(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:119
Parameters
event
Returns
void
onPause()?
optionalonPause(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:122
Parameters
event
PauseEvent
Returns
void
onRead()?
optionalonRead(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:116
Parameters
event
Returns
void
onResume()?
optionalonResume(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:123
Parameters
event
ResumeEvent
Returns
void
onStageEnd()?
optionalonStageEnd(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:121
Parameters
event
Returns
void
onStageStart()?
optionalonStageStart(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:120
Parameters
event
Returns
void
onWrite()?
optionalonWrite(event):void
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:117
Parameters
event
Returns
void
toSnapshot()?
optionaltoSnapshot():object
Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:136
Expose collected data for inclusion in executor.getSnapshot().recorders.
Returns
object
data
data:
unknown
description?
optionaldescription?:string
name
name:
string
preferredOperation?
optionalpreferredOperation?:"translate"|"accumulate"|"aggregate"
