Interface: BenchmarkScenario

Defined in: src/benchmark/BenchmarkMetrics.ts:34

Definition of an individual benchmark scenario.

Properties

name

name: string

Defined in: src/benchmark/BenchmarkMetrics.ts:36

Unique descriptive name of the scenario

---

category

category: string

Defined in: src/benchmark/BenchmarkMetrics.ts:38

Grouping category (e.g., 'Raw SQL', 'DbSet Query', 'Bulk Mutations')

---

iterations?

optional iterations?: number

Defined in: src/benchmark/BenchmarkMetrics.ts:40

Optional custom iteration count for this scenario

---

warmupIterations?

optional warmupIterations?: number

Defined in: src/benchmark/BenchmarkMetrics.ts:42

Optional custom warmup count for this scenario

---

setup?

optional setup?: () => void | Promise<void>

Defined in: src/benchmark/BenchmarkMetrics.ts:44

Optional setup callback run once before timed iterations

Returns

void | Promise<void>

---

fn

fn: () => void | Promise<void>

Defined in: src/benchmark/BenchmarkMetrics.ts:46

The operation to be benchmarked and timed

Returns

void | Promise<void>

---

teardown?

optional teardown?: () => void | Promise<void>

Defined in: src/benchmark/BenchmarkMetrics.ts:48

Optional teardown callback run once after timed iterations

Returns

void | Promise<void>