Interface BenchMetrics

packages/bench/src/types.ts:60–99

// ── Aggregated Bench Metrics ───────────────────────────────────────

export interface BenchMetrics {
  /** Per-iteration timing distribution */
  timing: TimingStats;
  /** Memory before the measured loop */
  memBefore: MemorySnapshot;
  /** Memory after the measured loop */
  memAfter: MemorySnapshot;
  /** Peak memory observed during the loop */
  memPeak: MemorySnapshot;
  /** RSS growth during the measured loop (KB). */
  rssGrowthKb: number;
  /** heapUsed growth during the measured loop (KB). */
  heapUsedGrowthKb: number | null;
  /**
   * Estimated memory growth slope (KB / iteration), if the scenario collects samples.
   * `null` if not measured.
   */
  rssSlopeKbPerIter: number | null;
  /** See rssSlopeKbPerIter. */
  heapUsedSlopeKbPerIter: number | null;
  /** True/false if slope is evaluated against a stability threshold, else null. */
  memStable: boolean | null;
  /** CPU time consumed by the measured loop */
  cpu: CpuUsage;
  /** Number of measured iterations (excludes warmup) */
  iterations: number;
  /** Total wall-clock time for the measured loop (ms) */
  totalWallMs: number;
  /** Operations per second */
  opsPerSec: number;
  /** Frames or writes delivered (for async pipelines) */
  framesProduced: number;
  /** Total bytes produced (drawlist or ANSI) */
  bytesProduced: number;
  /**
   * PTY bytes observed by the parent process for this run (if measured).
   * Useful when framework-local byte counters are unavailable.
   */
  ptyBytesObserved: number | null;
}

// ── Result Envelope ────────────────────────────────────────────────