Skip to main content
Version: Next

RemotePlaywrightPluginOptions

Options shared by all remote browser plugins.

Hierarchy

Index

Properties

Properties

optionalinheritedbrowserPerProxy

browserPerProxy?: boolean

If set to true, the crawler respects the proxy url generated for the given request. This aligns the browser-based crawlers with the HttpCrawler.

Might cause performance issues, as Crawlee might launch too many browser instances.

optionalinheritedconnectOptions

connectOptions?: Record<string, unknown>

Extra options forwarded to the library connect() call (endpoint excluded).

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.

optionalinheritedignoreProxyCertificate

ignoreProxyCertificate?: boolean

If set to true, TLS certificate errors from the upstream proxy will be ignored. This is useful when using HTTPS proxies with self-signed certificates.

optionalinheritedlaunchOptions

launchOptions?: LaunchOptions

Options that will be passed down to the automation library. E.g. puppeteer.launch(launchOptions);. This is a good place to set options that you want to apply as defaults. To dynamically override those options per-browser, see the preLaunchHooks of BrowserPool.

optionalprotocol

protocol?: cdp | playwright

Which protocol to connect with. 'cdp' uses connectOverCDP() (the default), 'playwright' uses connect() (Playwright's own WebSocket protocol, for endpoints started with launchServer()).

optionalinheritedproxyUrl

proxyUrl?: string

Automation libraries configure proxies differently. This helper allows you to set a proxy URL without worrying about specific implementations. It also allows you use an authenticated proxy without extra code.

optionalinheritedrelease

release?: (info) => unknown

Cleanup callback invoked when the browser disconnects or the connection fails right after the endpoint resolved. 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

optionalinheriteduseIncognitoPages

useIncognitoPages?: boolean = false

By default pages share the same browser context. If set to true each page uses its own context that is destroyed once the page is closed or crashes.

optionalinheriteduserDataDir

userDataDir?: string

Path to a User Data Directory, which stores browser session data like cookies and local storage.

Page Options