Class DebugRecorder

Each instance gets a unique auto-increment ID (debug-1, debug-2, ...), so multiple recorders with different verbosity coexist.

Example

// Verbose debug for development
executor.attachScopeRecorder(new DebugRecorder({ verbosity: 'verbose' }));

// Minimal debug for production (errors, pauses, resumes and attempt rows; no reads, writes or stage start/end)
executor.attachScopeRecorder(new DebugRecorder({ verbosity: 'minimal' }));

// Both coexist — different auto IDs

Implements

ScopeRecorder

Index

Constructors

constructor

new DebugRecorder(options?: DebugRecorderOptions): DebugRecorder
Parameters
- Optionaloptions: DebugRecorderOptions
Returns DebugRecorder
- Defined in lib/scope/recorders/DebugRecorder.ts:73

Properties

`Readonly`id

id: string

`Readonly`preferredOperation

preferredOperation: RecorderOperation

Methods

clear

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

Returns void
Implementation of ScopeRecorder.clear
- Defined in lib/scope/recorders/DebugRecorder.ts:209

getEntries

getEntries(): DebugEntry[]
Returns DebugEntry[]
- Defined in lib/scope/recorders/DebugRecorder.ts:189

getEntriesForStage

getEntriesForStage(stageName: string): DebugEntry[]
Parameters
- stageName: string
Returns DebugEntry[]
- Defined in lib/scope/recorders/DebugRecorder.ts:197

getErrors

getErrors(): DebugEntry[]
Returns DebugEntry[]
- Defined in lib/scope/recorders/DebugRecorder.ts:193

getVerbosity

getVerbosity(): DebugVerbosity
Returns DebugVerbosity
- Defined in lib/scope/recorders/DebugRecorder.ts:205

onAttempt

onAttempt(event: FlowAttemptEvent): void
Parameters
- event: FlowAttemptEvent
Returns void
- Defined in lib/scope/recorders/DebugRecorder.ts:152

onError

onError(event: ErrorEvent): void
Parameters
- event: ErrorEvent
Returns void
Implementation of ScopeRecorder.onError
- Defined in lib/scope/recorders/DebugRecorder.ts:99

onPause

onPause(event: PauseEvent): void
Parameters
- event: PauseEvent
Returns void
Implementation of ScopeRecorder.onPause
- Defined in lib/scope/recorders/DebugRecorder.ts:130

onRead

onRead(event: ReadEvent): void
Parameters
- event: ReadEvent
Returns void
Implementation of ScopeRecorder.onRead
- Defined in lib/scope/recorders/DebugRecorder.ts:79

onResume

onResume(event: ResumeEvent): void
Parameters
- event: ResumeEvent
Returns void
Implementation of ScopeRecorder.onResume
- Defined in lib/scope/recorders/DebugRecorder.ts:141

onStageEnd

onStageEnd(event: StageEvent): void
Parameters
- event: StageEvent
Returns void
Implementation of ScopeRecorder.onStageEnd
- Defined in lib/scope/recorders/DebugRecorder.ts:120

onStageStart

onStageStart(event: StageEvent): void
Parameters
- event: StageEvent
Returns void
Implementation of ScopeRecorder.onStageStart
- Defined in lib/scope/recorders/DebugRecorder.ts:110

onWrite

onWrite(event: WriteEvent): void
Parameters
- event: WriteEvent
Returns void
Implementation of ScopeRecorder.onWrite
- Defined in lib/scope/recorders/DebugRecorder.ts:89

setVerbosity

setVerbosity(level: DebugVerbosity): void
Parameters
- level: DebugVerbosity
Returns void
- Defined in lib/scope/recorders/DebugRecorder.ts:201

toSnapshot

toSnapshot(): {
    data: DebugEntry[];
    description: string;
    name: string;
    preferredOperation: RecorderOperation;
}
Expose collected data for inclusion in executor.getSnapshot().recorders.

Returns {
    data: DebugEntry[];
    description: string;
    name: string;
    preferredOperation: RecorderOperation;
}
Implementation of ScopeRecorder.toSnapshot
- Defined in lib/scope/recorders/DebugRecorder.ts:213

Class DebugRecorder

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DebugRecorder

Properties

Readonlyid

ReadonlypreferredOperation

Methods

clear

Returns void

getEntries

Returns DebugEntry[]

getEntriesForStage

Parameters

Returns DebugEntry[]

getErrors

Returns DebugEntry[]

getVerbosity

Returns DebugVerbosity

onAttempt

Parameters

Returns void

onError

Parameters

Returns void

onPause

Parameters

Returns void

onRead

Parameters

Returns void

onResume

Parameters

Returns void

onStageEnd

Parameters

Returns void

onStageStart

Parameters

Returns void

onWrite

Parameters

Returns void

setVerbosity

Parameters

Returns void

toSnapshot

Returns { data: DebugEntry[]; description: string; name: string; preferredOperation: RecorderOperation;}

Settings

On This Page

`Readonly`id

`Readonly`preferredOperation

Returns {
data: DebugEntry[];
description: string;
name: string;
preferredOperation: RecorderOperation;
}