Skip to main content
Version: Next

RemotePlaywrightBrowserPoolOptions

Hierarchy

Index

Properties

Properties

optionalinheritedbrowserPoolOptions

browserPoolOptions?: Omit<BrowserPoolOptions<BrowserPlugin<CommonLibrary, undefined | Dictionary, CommonBrowser, unknown, CommonPage>>, browserPlugins> & BrowserPoolHooks<any, any, any>

Extra BrowserPool options (lifecycle hooks, page limits, fingerprinting, …).

optionalinheritedconfiguration

configuration?: Configuration

Configuration to read the browser defaults from. Defaults to the global configuration.

optionalinheritedconnection

connection?: RemoteConnectionParameters

Static connect() parameters (Playwright protocol selection, headers, timeouts, …).

inheritedendpoint

endpoint: RemoteBrowserProvider<any> | RemoteBrowserEndpoint

The remote browser endpoint: a static URL, a function returning one per launch, or a RemoteBrowserProvider instance encapsulating a session create/release lifecycle.

optionalinheritedheadless

headless?: boolean

Whether to run the browser in headless mode. Shorthand for launchContext.launchOptions.headless. Defaults to true, and can also be set via Configuration.

optionalinheritedlaunchContext

launchContext?: PlaywrightLaunchContext

How to launch the browser: which Playwright browser type, proxy, user data dir, ...

optionalinheritedmaxOpenBrowsers

maxOpenBrowsers?: number

Maximum number of remote browsers open at once. When reached, newPage waits for a browser to close before connecting a new one. Set it to your service's concurrent-session limit to avoid 429 errors. Defaults to the provider's value, or Infinity.

optionalinheritedrelease

release?: (info) => unknown

Cleanup callback invoked when a browser closes, crashes, or the pool is destroyed. Receives the context returned by a function endpoint. Errors are caught and logged. Ignored when endpoint is a RemoteBrowserProvider (its own release() is used instead).

Type declaration

    • (info): unknown

    • Parameters

      • info: { context?: Record<string, unknown>; endpoint: string }
        • optionalcontext: Record<string, unknown>
        • endpoint: string

      Returns unknown

optionalinheritedslotPollIntervalMillis

slotPollIntervalMillis?: number = 500

Fallback poll interval (ms) while waiting for a free browser slot. The wait is event-driven; this only bounds it.

Page Options