Axinom Mosaic Libraries
    Preparing search index...

    Interface RunScenarioConfig<TC>

    Configuration for the runScenario function.

    interface RunScenarioConfig<TC> {
        description?: string;
        generateReport: (tc: TC) => Promise<string>;
        hasScenarioCompleted: (tc: TC) => Promise<boolean>;
        iteration: (tc: TC) => Promise<void>;
        runnerConfig: RunnerConfig;
        setup: () => Promise<TC>;
        teardown: (tc: TC) => Promise<void>;
    }

    Type Parameters

    • TC
    Index

    Properties

    description? generateReport hasScenarioCompleted iteration runnerConfig setup teardown

    Properties

    description?: string

    Description of the scenario. Printed together with the report.

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

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

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

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

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

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

    runnerConfig: RunnerConfig

    Configuration to fine-tune how scenario is executed.

    setup: () => Promise<TC>

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

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

    Function to cleanup after scenario is completed.

    Settings

    Member Visibility

    On This Page

    Properties