@nx/playwright/dist/src/utils/preset.d.ts

The Nx Plugin for Playwright contains executors and generators allowing your workspace to use the powerful Playwright integration testing capabilities.

export interface NxPlaywrightOptions {
    /**
     * The directory where the e2e tests are located.
     * @default './src'
     **/
    testDir?: string;
    /**
     * Open the html report after the test run.
     * @default 'on-failure'
     */
    openHtmlReport?: 'always' | 'never' | 'on-failure';
    /**
     * Whether to generate blob reports. Useful when running atomized tasks in CI
     * and you want to merge the reports.
     * @default `!!process.env['CI']`
     */
    generateBlobReports?: boolean;
}
/**
 * nx E2E Preset for Playwright
 * @description
 * this preset contains the base configuration
 * for your e2e tests that nx recommends.
 * By default html reporter is configured
 * along with the following browsers:
 * - chromium
 * - firefox
 * - webkit
 * These are generated by default.
 *
 * you can easily extend this within your playwright config via spreading the preset
 * @example
 * // Nx generates `playwright.config.mts` (ESM). Pass `import.meta.dirname`.
 * // For hand-written CJS configs (`.cts` or `.ts` outside a `type: "module"`
 * // workspace), pass `__filename` instead.
 * export default defineConfig({
 *   ...nxE2EPreset(import.meta.dirname, options)
 *   // add your own config here
 * })
 *
 * @param pathToConfig will be used to construct the output paths for reporters and test results
 * @param options optional configuration options
 */
export declare function nxE2EPreset(pathToConfig: string, options?: NxPlaywrightOptions): import("@playwright/test").PlaywrightTestConfig<{}, {}>;