PuppeteerController

The BrowserController serves two purposes. First, it is the base class that specialized controllers like PuppeteerController or PlaywrightController 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.

Hierarchy

• BrowserController<typeof Puppeteer, PuppeteerTypes.PuppeteerLaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>
  • PuppeteerController

Index

Constructors

• constructor

Properties

• activePages
• browser
• browserPlugin
• id
• isActive
• lastPageOpenedAt
• launchContext
• proxyTier
• proxyUrl
• totalPages
• defaultMaxListeners

Methods

• addListener
• close
• emit
• eventNames
• getCookies
• getMaxListeners
• kill
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• setCookies
• setMaxListeners

Constructors

constructor

• new PuppeteerController(browserPlugin: BrowserPlugin<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>): PuppeteerController

• Inherited from BrowserController< typeof Puppeteer, PuppeteerTypes.PuppeteerLaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions >.constructor

  Parameters

  • browserPlugin: BrowserPlugin<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>

  Returns PuppeteerController

Properties

inheritedactivePages

activePages: number = 0

Inherited from BrowserController.activePages

inheritedbrowser

browser: Browser = ...

Inherited from BrowserController.browser

Browser representation of the underlying automation library.

inheritedbrowserPlugin

browserPlugin: BrowserPlugin<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>

Inherited from BrowserController.browserPlugin

The BrowserPlugin instance used to launch the browser.

inheritedid

id: string = ...

Inherited from BrowserController.id

inheritedisActive

isActive: boolean = false

Inherited from BrowserController.isActive

inheritedlastPageOpenedAt

lastPageOpenedAt: number = ...

Inherited from BrowserController.lastPageOpenedAt

inheritedlaunchContext

launchContext: LaunchContext<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page> = ...

Inherited from BrowserController.launchContext

The configuration the browser was launched with.

optionalinheritedproxyTier

proxyTier?: number

Inherited from BrowserController.proxyTier

The proxy tier tied to this browser controller. undefined if no tiered proxy is used.

optionalinheritedproxyUrl

proxyUrl?: string

Inherited from BrowserController.proxyUrl

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

totalPages: number = 0

Inherited from BrowserController.totalPages

staticexternalinheriteddefaultMaxListeners

defaultMaxListeners: number

Inherited from BrowserController.defaultMaxListeners

Methods

externalinheritedaddListener

• addListener(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.addListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

inheritedclose

• close(): Promise<void>

• Inherited from BrowserController.close

  Gracefully closes the browser and makes sure there will be no lingering browser processes.

  Emits 'browserClosed' event.

  ---

  Returns Promise<void>

externalinheritedemit

• emit(event: U, ...args: Parameters<BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]>): boolean

• Inherited from BrowserController.emit

  Parameters

  • externalevent: U

  • externalrest...args: Parameters<BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]>

  Returns boolean

externalinheritedeventNames

• eventNames(): U[]

• Inherited from BrowserController.eventNames

  Returns U[]

inheritedgetCookies

• getCookies(page: Page): Promise<Cookie[]>

• Inherited from BrowserController.getCookies

  Parameters

  • page: Page

  Returns Promise<Cookie[]>

externalinheritedgetMaxListeners

• getMaxListeners(): number

• Inherited from BrowserController.getMaxListeners

  Returns number

inheritedkill

• kill(): Promise<void>

• Inherited from BrowserController.kill

  Immediately kills the browser process.

  Emits 'browserClosed' event.

  ---

  Returns Promise<void>

externalinheritedlistenerCount

• listenerCount(type: BROWSER_CLOSED): number

• Inherited from BrowserController.listenerCount

  Parameters

  • externaltype: BROWSER_CLOSED

  Returns number

externalinheritedlisteners

• listeners(type: U): BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]

• Inherited from BrowserController.listeners

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]

externalinheritedoff

• off(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.off

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

externalinheritedon

• on(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.on

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

externalinheritedonce

• once(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.once

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

externalinheritedprependListener

• prependListener(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.prependListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

externalinheritedprependOnceListener

• prependOnceListener(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.prependOnceListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

externalinheritedrawListeners

• rawListeners(type: U): BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]

• Inherited from BrowserController.rawListeners

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U][]

externalinheritedremoveAllListeners

• removeAllListeners(event?: BROWSER_CLOSED): this

• Inherited from BrowserController.removeAllListeners

  Parameters

  • externaloptionalevent: BROWSER_CLOSED

  Returns this

externalinheritedremoveListener

• removeListener(event: U, listener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]): this

• Inherited from BrowserController.removeListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<PuppeteerNode, PuppeteerLaunchOptions, Browser, PuppeteerNewPageOptions, Page>[U]

  Returns this

inheritedsetCookies

• setCookies(page: Page, cookies: Cookie[]): Promise<void>

• Inherited from BrowserController.setCookies

  Parameters

  • page: Page

  • cookies: Cookie[]

  Returns Promise<void>

externalinheritedsetMaxListeners

• setMaxListeners(n: number): this

• Inherited from BrowserController.setMaxListeners

  Parameters

  • externaln: number

  Returns this