Class QualityRecorder

constructor

• new QualityRecorder(
      scoringFn: QualityScoringFn,
      options?: QualityRecorderOptions,
  ): QualityRecorder

  Parameters

  • scoringFn: QualityScoringFn
  • Optionaloptions: QualityRecorderOptions

  Returns QualityRecorder

Readonlyid

ReadonlypreferredOperation

size

• get size(): number

  Number of scored steps.

  Returns number

accumulate

• accumulate<R>(
      fn: (acc: R, entry: QualityEntry, key: string) => R,
      initial: R,
      keys?: ReadonlySet<string>,
  ): R

  Accumulate: reduce scored steps up to a slider position.

  Type Parameters

  • R

  Parameters

  • fn: (acc: R, entry: QualityEntry, key: string) => R
  • initial: R
  • Optionalkeys: ReadonlySet<string>

  Returns R

aggregate

• aggregate<R>(fn: (acc: R, entry: QualityEntry, key: string) => R, initial: R): R

  Aggregate: reduce ALL scored steps to a single value.

  Type Parameters

  • R

  Parameters

  • fn: (acc: R, entry: QualityEntry, key: string) => R
  • initial: R

  Returns R

clear

• clear(): void

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

  Returns void

getByKey

• getByKey(runtimeStageId: string): QualityEntry | undefined

  Translate: quality entry for a specific runtimeStageId.

  Parameters

  • runtimeStageId: string

  Returns QualityEntry | undefined

getLowest

• getLowest(): { entry: QualityEntry; runtimeStageId: string } | undefined

  Find the lowest-scoring step.

  Returns { entry: QualityEntry; runtimeStageId: string } | undefined

getMap

• getMap(): ReadonlyMap<string, QualityEntry>

  All per-step quality entries as a read-only Map (insertion-ordered).

  Returns ReadonlyMap<string, QualityEntry>

getOverallScore

• getOverallScore(): number

  Overall quality score — average of all step scores.

  Returns number

getScoreUpTo

• getScoreUpTo(visibleKeys: ReadonlySet<string>): number

  Progressive quality score up to a slider position.

  Parameters

  • visibleKeys: ReadonlySet<string>

  Returns number

onAttempt

• onAttempt(event: FlowAttemptEvent): void

  A series that ended after giving up or timing out is a drop at its stage. onAttempt for the last attempt fires after that attempt's onStageEnd (when it returned), so a recovered series amends the scored entry; a series that gave up has none, and is scored here.

  Parameters

  • event: FlowAttemptEvent

  Returns void

onRead

• onRead(event: ReadEvent): void

  Parameters

  • event: ReadEvent

  Returns void

onStageEnd

• onStageEnd(event: StageEvent): void

  Parameters

  • event: StageEvent

  Returns void

onStageStart

• onStageStart(event: StageEvent): void

  Parameters

  • event: StageEvent

  Returns void

onWrite

• onWrite(event: WriteEvent): void

  Parameters

  • event: WriteEvent

  Returns void

toSnapshot

• toSnapshot(): {
      data: {
          lowestStep: string
          | undefined;
          numericField: string;
          overallScore: number;
          steps: Record<string, unknown>;
      };
      description: string;
      name: string;
      preferredOperation: RecorderOperation;
  }

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

  Returns {
      data: {
          lowestStep: string | undefined;
          numericField: string;
          overallScore: number;
          steps: Record<string, unknown>;
      };
      description: string;
      name: string;
      preferredOperation: RecorderOperation;
  }

values

• values(): QualityEntry[]

  All per-step quality entries (insertion-ordered).

  Returns QualityEntry[]