Skip to main content
Version: Next

BrowserPoolNewPageOptions <PageOptions, BP>

Options accepted by IBrowserPool.newPage.

Hierarchy

Index

Properties

Properties

optionalbrowserPlugin

browserPlugin?: BP

Choose a plugin to open the page with. If none is provided, one of the pool's available plugins will be used.

It must be one of the plugins browser pool was created with. If you wish to start a browser with a different configuration, see the newPageInNewBrowser function.

optionalinheritedid

id?: string

Assign a custom ID to the page. If you don't provide one, a random string ID is generated.

optionalignoreTlsErrors

ignoreTlsErrors?: boolean

Disable TLS certificate verification for MITM proxies. Applied both when launching a new browser and when creating a page in an existing one. When omitted, it is derived from the session's proxyInfo; an explicit value here takes precedence.

This is an implementation detail of the built-in BrowserPool and is intentionally not part of the IBrowserPool contract — through that interface, configure it via the session's proxyInfo or through the browser's launchOptions.

optionalpageOptions

pageOptions?: PageOptions

Some libraries (Playwright) allow you to open new pages with specific options. Use this property to set those options.

optionalproxyUrl

proxyUrl?: string

The proxy URL the pool uses internally to route the page: it keys browser reuse (with browserPerProxy, only a browser already on this proxy is reused), configures the launched browser, and is applied to incognito pages. When omitted, it is derived from the session's proxyInfo; an explicit value here takes precedence.

This is an implementation detail of the built-in BrowserPool's proxy handling and is intentionally not part of the IBrowserPool contract — through that interface the proxy is supplied via the session.

optionalinheritedsession

session?: ISession

The crawling session that will use the returned page.

The pool derives proxy configuration from the session's proxy (including TLS-error handling) — there are intentionally no standalone proxyUrl / ignoreTlsErrors options; configure them through the session instead.

Session injection is best-effort: the pool may use the session's proxy, cookies, or fingerprint data to configure the page or the underlying browser, but none of this is guaranteed. Different pool implementations (or pool configurations such as useIncognitoPages) may support different subsets of session properties — or ignore them entirely.

The crawler is still responsible for deterministic session setup (e.g. injecting cookies into the page before navigation) that must happen regardless of pool implementation.

Page Options