Skip to main content

CustomScenario

@webda/bench

Interface: CustomScenario

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

Scenario measuring itself: throughput of a drain, fan-out deliveries...

Extends​

Properties​

name​

name: string

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

Scenario name, prefixed by the suite: store.get

Inherited from​

BaseScenario.name

params?​

optional params?: BenchParams

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

Parameters of this run, part of the result key

Inherited from​

BaseScenario.params

Methods​

run()​

run(latency): Promise<CustomScenarioOutcome>

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

Run the scenario

Parameters​

latency​

LatencyRecorder

recorder for the latencies of the operations

Returns​

Promise<CustomScenarioOutcome>

setup()?​

optional setup(): Promise<void>

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

Prepare the scenario, not measured

Returns​

Promise<void>

Inherited from​

BaseScenario.setup

teardown()?​

optional teardown(): Promise<void>

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

Clean after the scenario, not measured

Returns​

Promise<void>

Inherited from​

BaseScenario.teardown

verify()?​

optional verify(): Promise<ScenarioChecks>

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

Check the correctness after the measurement, not measured

Returns​

Promise<ScenarioChecks>

Inherited from​

BaseScenario.verify