Skip to content

Commit

Permalink
docs(browser-pool): explain retire session in retireBrowserAfterPageC… (
Browse files Browse the repository at this point in the history
apify#2246)

I'm not sure if the `apinlik`s are correct
  • Loading branch information
metalwarrior665 committed Dec 19, 2023
1 parent fdfec4f commit 2a5b94b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/browser-pool/src/browser-pool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ export interface BrowserPoolOptions<Plugin extends BrowserPlugin = BrowserPlugin
maxOpenPagesPerBrowser?: number;
/**
* Browsers tend to get bloated after processing a lot of pages. This option
* configures the number of processed pages after which the browser will
* 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 {@apilink Session} is retired.
* You can change session retirement behavior using {@apilink SessionPoolOptions}.
*
* @default 100
*/
Expand Down

0 comments on commit 2a5b94b

Please sign in to comment.