Interface RunScenarioConfig<TC>

Configuration for the runScenario function.

Type Parameters

  • TC

Hierarchy

  • RunScenarioConfig

Properties

description? generateReport hasScenarioCompleted iteration runnerConfig setup teardown

Properties

Optional description

description?: string

Description of the scenario. Printed together with the report.

generateReport

generateReport: ((tc) => Promise<string>)

Type declaration

    • (tc): Promise<string>

    • Function to generate a report for the scenario. Printed as is.

      Parameters

      • tc: TC

      Returns Promise<string>

hasScenarioCompleted

hasScenarioCompleted: ((tc) => Promise<boolean>)

Type declaration

    • (tc): Promise<boolean>

    • Function to check if scenario is completed, e.g. call a service API and return true or false based on response.

      Parameters

      • tc: TC

      Returns Promise<boolean>

iteration

iteration: ((tc) => Promise<void>)

Type declaration

    • (tc): Promise<void>

    • Function that will be repeatedly executed as many times as defined in runnerConfig.iterations.

      Parameters

      • tc: TC

      Returns Promise<void>

runnerConfig

runnerConfig: RunnerConfig

Configuration to fine-tune how scenario is executed.

setup

setup: (() => Promise<TC>)

Type declaration

    • (): Promise<TC>

    • Function to set up initial data that can be reused by other scenario functions.

      Returns Promise<TC>

teardown

teardown: ((tc) => Promise<void>)

Type declaration

    • (tc): Promise<void>

    • Function to cleanup after scenario is completed.

      Parameters

      • tc: TC

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc