effect-playwright
    Preparing search index...

    Interface FullConfig<TestArgs, WorkerArgs>

    Resolved configuration which is accessible via testInfo.config and is passed to the test reporters. To see the format of Playwright configuration file, please see TestConfig instead.

    interface FullConfig<TestArgs = {}, WorkerArgs = {}> {
        argv: string[];
        configFile?: string;
        failOnFlakyTests: boolean;
        forbidOnly: boolean;
        fullyParallel: boolean;
        globalSetup: string | null;
        globalTeardown: string | null;
        globalTimeout: number;
        grep: RegExp | RegExp[];
        grepInvert: RegExp | RegExp[] | null;
        maxFailures: number;
        metadata: Metadata;
        preserveOutput: "always" | "never" | "failures-only";
        projects: FullProject<TestArgs, WorkerArgs>[];
        quiet: boolean;
        reporter: ReporterDescription[];
        reportSlowTests: { max: number; threshold: number } | null;
        rootDir: string;
        shard: { current: number; total: number } | null;
        tags: string[];
        updateSnapshots: "none" | "all" | "missing" | "changed";
        updateSourceMethod: "overwrite" | "3way" | "patch";
        version: string;
        webServer: TestConfigWebServer | null;
        workers: number;
    }

    Type Parameters

    • TestArgs = {}
    • WorkerArgs = {}
    Index
    argv configFile? failOnFlakyTests forbidOnly fullyParallel globalSetup globalTeardown globalTimeout grep grepInvert maxFailures metadata preserveOutput projects quiet reporter reportSlowTests rootDir shard tags updateSnapshots updateSourceMethod version webServer workers
    argv: string[]

    Snapshot of process.argv captured in the runner process. Useful for reading custom command-line arguments — for example, args supplied after the -- separator (npx playwright test -- --build-path=./out). Playwright does not parse these; consumers are responsible for slicing and interpreting them with any argument-parsing library.

    configFile?: string

    Path to the configuration file used to run the tests. The value is an empty string if no config file was used.

    failOnFlakyTests: boolean

    See testConfig.failOnFlakyTests.

    forbidOnly: boolean

    See testConfig.forbidOnly.

    fullyParallel: boolean

    See testConfig.fullyParallel.

    globalSetup: string | null

    See testConfig.globalSetup.

    globalTeardown: string | null

    See testConfig.globalTeardown.

    globalTimeout: number

    See testConfig.globalTimeout.

    grep: RegExp | RegExp[]

    See testConfig.grep.

    grepInvert: RegExp | RegExp[] | null

    See testConfig.grepInvert.

    maxFailures: number

    See testConfig.maxFailures.

    metadata: Metadata

    See testConfig.metadata.

    preserveOutput: "always" | "never" | "failures-only"

    See testConfig.preserveOutput.

    projects: FullProject<TestArgs, WorkerArgs>[]

    List of resolved projects.

    quiet: boolean

    See testConfig.quiet.

    reporter: ReporterDescription[]

    See testConfig.reporter.

    reportSlowTests: { max: number; threshold: number } | null

    See testConfig.reportSlowTests.

    Type Declaration

    • { max: number; threshold: number }
      • max: number

        The maximum number of slow test files to report.

      • threshold: number

        Test file duration in milliseconds that is considered slow.

    • null
    rootDir: string

    Base directory for all relative paths used in the reporters.

    shard: { current: number; total: number } | null

    See testConfig.shard.

    Type Declaration

    • { current: number; total: number }
      • current: number

        The index of the shard to execute, one-based.

      • total: number

        The total number of shards.

    • null
    tags: string[]

    Resolved global tags. See testConfig.tag.

    updateSnapshots: "none" | "all" | "missing" | "changed"

    See testConfig.updateSnapshots.

    updateSourceMethod: "overwrite" | "3way" | "patch"

    See testConfig.updateSourceMethod.

    version: string

    Playwright version.

    webServer: TestConfigWebServer | null

    See testConfig.webServer.

    workers: number

    See testConfig.workers.

    Settings
    Member Visibility

    On This Page
    Properties