Interface: ScopeRecorder

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:97

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

readonly id: string

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:98

Methods

clear()?

optional clear(): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:117

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

Returns

void

---

onCommit()?

optional onCommit(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:101

Parameters

event

CommitEvent

Returns

void

---

onEmit()?

optional onEmit(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:115

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

EmitEvent

Returns

void

See

EmitRecorder in src/lib/recorder/EmitRecorder.ts

---

onError()?

optional onError(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:102

Parameters

event

ErrorEvent

Returns

void

---

onPause()?

optional onPause(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:105

Parameters

event

PauseEvent

Returns

void

---

onRead()?

optional onRead(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:99

Parameters

event

ReadEvent

Returns

void

---

onResume()?

optional onResume(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:106

Parameters

event

ResumeEvent

Returns

void

---

onStageEnd()?

optional onStageEnd(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:104

Parameters

event

StageEvent

Returns

void

---

onStageStart()?

optional onStageStart(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:103

Parameters

event

StageEvent

Returns

void

---

onWrite()?

optional onWrite(event): void

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:100

Parameters

event

WriteEvent

Returns

void

---

toSnapshot()?

optional toSnapshot(): RecorderBundle

Defined in: node_modules/footprintjs/dist/types/lib/scope/types.d.ts:119

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

Returns

RecorderBundle