createPuppeteerCaptureRunner
createPuppeteerCaptureRunner(
options?):CaptureRunner
Defined in: runner-puppeteer/src/capture-runner.ts:26
Create a CaptureRunner that renders Storybook stories with Puppeteer (Chromium via chrome-headless-shell).
Parameters
Section titled “Parameters”options?
Section titled “options?”string[]
Launch flags for local engines; replaces the default sandbox and low-memory flags.
browsers?
Section titled “browsers?”readonly BrowserEntry[]
Every target the runner offers, default first (ADR 0007, decision 1): "chromium",
local(engine, { executablePath }), or remote CDP services from
@storyshelf/runner-puppeteer/remote (cdp(...): <engine>@<name> targets that need a
Storybook URL they can reach). Default ["chromium"]. Chromium-family engines only; bare
"chrome" needs local("chrome", { executablePath }).
concurrency?
Section titled “concurrency?”number
Pages rendered at once; falls back to STORYSHELF_CAPTURE_CONCURRENCY, then CPU/memory detection.
executablePath?
Section titled “executablePath?”string
The executable bare entries launch (puppeteer-core ships no browser).
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