createPlaywrightCaptureRunner
createPlaywrightCaptureRunner(
options?):CaptureRunner
Defined in: runner-playwright/src/capture-runner.ts:27
Create a CaptureRunner that renders Storybook stories with Playwright.
Parameters
Section titled “Parameters”options?
Section titled “options?”browsers?
Section titled “browsers?”readonly BrowserEntry[]
Every target the runner offers, default first (ADR 0007, decision 1): engine names,
local(engine, options), or remote services from @storyshelf/runner-playwright/remote
(<engine>@<name> targets). Default ["chromium"]; Firefox and WebKit are offered only when
listed, and their binaries provisioned (playwright install), which playwright-core never
does. A list with no local entry needs no installed browsers.
concurrency?
Section titled “concurrency?”number
Pages rendered at once; falls back to STORYSHELF_CAPTURE_CONCURRENCY, then CPU/memory detection.
navigationTimeoutMs?
Section titled “navigationTimeoutMs?”number
Per-page timeout in ms; falls back to STORYSHELF_NAVIGATION_TIMEOUT_MS, then CPU detection.
recycleBrowserEvery?
Section titled “recycleBrowserEvery?”number
Captures between browser restarts (0 disables); falls back to STORYSHELF_BROWSER_RECYCLE_EVERY, then 150.
reusePages?
Section titled “reusePages?”boolean
Reuse pages between captures (opt-in); falls back to STORYSHELF_REUSE_PAGES=1.
Returns
Section titled “Returns”CaptureRunner