Module footprintjs/recorders

Recorder factories.

Prefer these factory functions over constructing recorder classes directly. Each factory returns the recorder instance enriched with short convenience methods.

import { narrative, metrics, debug, manifest } from 'footprintjs/recorders';

const result = await chart
  .recorder(narrative())
  .recorder(metrics())
  .run();

Interfaces

AggregatedMetrics: Aggregated metrics across all invocations (backward compatible).
AttemptAggregate
AttemptDecisionRow: The explicit chart decision, after reconciliation; never rewrites a physical call's outcome.
AttemptMetricRef
AttemptQuery
AttemptRecorderOptions
AttemptRenderContext: Context passed to NarrativeFormatter.renderAttempt — one attempt of a stage with a declared retry policy (10.1), whatever its outcome.
AttemptRunRow
AttemptRunStats
AttemptStats
AttemptStorageStats
AttemptStore
BreakRenderContext: Context passed to renderBreak.
CombinedNarrativeRecorderOptions
DecisionRenderContext: Context passed to renderDecision.
EmitRenderContext: Context passed to NarrativeFormatter.renderEmit — fires for every consumer-emitted event (scope.$emit(name, payload)). Carries the full EmitEvent shape so formatters can render name + payload with full context.
ErrorRenderContext: Context passed to renderError.
ForkRenderContext: Context passed to renderFork.
LoopRenderContext: Context passed to renderLoop.
MetricRecorderOptions: Options for MetricRecorder.
OpRenderContext: Context passed to renderOp. Return null to exclude the entry.
PhysicalAttemptRow
SelectedRenderContext: Context passed to renderSelected.
StageMetrics: Aggregated per-stageName (backward compatible with pre-runtimeStageId API).
StageRenderContext: Context passed to renderStage.
SubflowRenderContext: Context passed to renderSubflow.

Type Aliases

AttemptRow
DebugInstance
ManifestInstance
MetricsInstance
NarrativeInstance: ScopeRecorder factory for combined flow+data narrative.

Functions

adaptive
attempts: Collect payload-free attempts during traversal; storage adapters are optional and provider-neutral.
debug
manifest
memoryStore: Bounded reference adapter for tests/local use; apps supply their own database adapter.
metrics
milestone
narrative
windowed

References

CompositeRecorder → CompositeRecorder
CompositeSnapshot → CompositeSnapshot
EmitEvent → EmitEvent
EmitRecorder → EmitRecorder
NarrativeFormatter → NarrativeFormatter

Module footprintjs/recorders

Interfaces

Type Aliases

Functions

References

Settings

On This Page