PuppeteerController
Hierarchy
- BrowserController<typeof Puppeteer, PuppeteerTypes.PuppeteerLaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>
- PuppeteerController
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
browserPlugin: BrowserPlugin<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>
Returns PuppeteerController
Properties
inheritedactivePages
inheritedbrowser
Browser representation of the underlying automation library.
inheritedbrowserPlugin
The BrowserPlugin
instance used to launch the browser.
inheritedid
inheritedisActive
inheritedlastPageOpenedAt
inheritedlaunchContext
The configuration the browser was launched with.
optionalinheritedproxyTier
The proxy tier tied to this browser controller.
undefined
if no tiered proxy is used.
optionalinheritedproxyUrl
The proxy URL used by the browser controller. This is set every time the browser controller uses proxy (even the tiered one).
undefined
if no proxy is used
inheritedtotalPages
staticexternalinheriteddefaultMaxListeners
Methods
externalinheritedaddListener
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
inheritedclose
Gracefully closes the browser and makes sure there will be no lingering browser processes.
Emits 'browserClosed' event.
Returns Promise<void>
externalinheritedemit
Parameters
externalevent: U
externalrest...args: Parameters<BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]>
Returns boolean
externalinheritedeventNames
Returns U[]
inheritedgetCookies
Parameters
page: Page
Returns Promise<Cookie[]>
externalinheritedgetMaxListeners
Returns number
inheritedkill
Immediately kills the browser process.
Emits 'browserClosed' event.
Returns Promise<void>
externalinheritedlistenerCount
Parameters
externaltype: BROWSER_CLOSED
Returns number
externalinheritedlisteners
Parameters
externaltype: U
Returns BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]
externalinheritedoff
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
externalinheritedon
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
externalinheritedonce
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
externalinheritedprependListener
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
externalinheritedprependOnceListener
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
externalinheritedrawListeners
Parameters
externaltype: U
Returns BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]
externalinheritedremoveAllListeners
Parameters
externaloptionalevent: BROWSER_CLOSED
Returns this
externalinheritedremoveListener
Parameters
externalevent: U
externallistener: BrowserControllerEvents<PuppeteerNode, LaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]
Returns this
inheritedsetCookies
Parameters
page: Page
cookies: Cookie[]
Returns Promise<void>
externalinheritedsetMaxListeners
Parameters
externaln: number
Returns this
The
BrowserController
serves two purposes. First, it is the base class that specialized controllers likePuppeteerController
orPlaywrightController
extend. Second, it defines the public interface of the specialized classes which provide only private methods. Therefore, we do not keep documentation for the specialized classes, because it's the same for all of them.