BrowserPoolOptions <Plugin>

Index

Properties

• browserPlugins
• closeInactiveBrowserAfterSecs
• fingerprintOptions
• maxOpenPagesPerBrowser
• operationTimeoutSecs
• retireBrowserAfterPageCount
• retireInactiveBrowserAfterSecs
• useFingerprints

Properties

browserPlugins

browserPlugins: readonly Plugin[]

Browser plugins are wrappers of browser automation libraries that allow BrowserPool to control browsers with those libraries. browser-pool comes with a PuppeteerPlugin and a PlaywrightPlugin.

optionalcloseInactiveBrowserAfterSecs

closeInactiveBrowserAfterSecs?: number = ```ts 300 ```

Browsers normally close immediately after their last page is processed. However, there could be situations where this does not happen. Browser Pool makes sure all inactive browsers are closed regularly, to free resources.

optionalfingerprintOptions

fingerprintOptions?: FingerprintOptions

optionalmaxOpenPagesPerBrowser

maxOpenPagesPerBrowser?: number = ```ts 20 ```

Sets the maximum number of pages that can be open in a browser at the same time. Once reached, a new browser will be launched to handle the excess.

optionaloperationTimeoutSecs

operationTimeoutSecs?: number = ```ts 15 ```

As we know from experience, async operations of the underlying libraries, such as launching a browser or opening a new page, can get stuck. To prevent BrowserPool from getting stuck, we add a timeout to those operations and you can configure it with this option.

optionalretireBrowserAfterPageCount

retireBrowserAfterPageCount?: number = ```ts 100 ```

Browsers tend to get bloated after processing a lot of pages. This option configures the maximum number of processed pages after which the browser will automatically retire and close. A new browser will launch in its place. The browser might be retired sooner if the connected Session is retired. You can change session retirement behavior using SessionPoolOptions.

optionalretireInactiveBrowserAfterSecs

retireInactiveBrowserAfterSecs?: number = ```ts 1 ```

Browsers are marked as retired after they have been inactive for a certain amount of time. This option sets the interval at which the browsers are checked and retired if they are inactive.

Retired browsers are closed after all their pages are closed.

optionaluseFingerprints

useFingerprints?: boolean = ```ts true ```