@stencil/playwright
Version:
Testing adapter to use Playwright with Stencil
25 lines (24 loc) • 1.16 kB
TypeScript
import { PlaywrightTestConfig } from '@playwright/test';
type DeepPartial<T> = T extends object ? {
[P in keyof T]?: DeepPartial<T[P]>;
} : T;
interface CreateConfigOptions {
/**
* Directory to start searching for the Stencil config file.
* Useful when the working directory differs from the test directory (e.g., VSCode Playwright extension).
* Defaults to process.cwd().
*/
cwd?: string;
}
/**
* Helper function to easily create a Playwright config for Stencil projects. This function will
* automatically load the Stencil config meta to set default values for the Playwright config respecting the
* Stencil dev server configuration, and set the Stencil namespace and entry path as environment variables for use
* in the Playwright tests.
*
* @param overrides Values to override in the default config. Any Playwright config option can be overridden.
* @param options Additional options for config creation.
* @returns A {@link PlaywrightTestConfig} object
*/
export declare const createConfig: (overrides?: DeepPartial<PlaywrightTestConfig>, options?: CreateConfigOptions) => Promise<PlaywrightTestConfig>;
export {};