BaseScenario

@webda/bench

---

Interface: BaseScenario

Defined in: packages/bench/src/runner.ts:31

Common definition of a scenario

Extended by

• ClosedLoopScenario
• OpenLoopScenario
• CustomScenario

Properties

name

name: string

Defined in: packages/bench/src/runner.ts:35

Scenario name, prefixed by the suite: store.get

---

params?

optional params?: BenchParams

Defined in: packages/bench/src/runner.ts:39

Parameters of this run, part of the result key

Methods

setup()?

optional setup(): Promise<void>

Defined in: packages/bench/src/runner.ts:43

Prepare the scenario, not measured

Returns

Promise<void>

---

teardown()?

optional teardown(): Promise<void>

Defined in: packages/bench/src/runner.ts:47

Clean after the scenario, not measured

Returns

Promise<void>

---

verify()?

optional verify(): Promise<ScenarioChecks>

Defined in: packages/bench/src/runner.ts:51

Check the correctness after the measurement, not measured

Returns

Promise<ScenarioChecks>