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.

@hideconstructor

Hierarchy

• BrowserController<typeof Puppeteer>
  • PuppeteerController

Index

Constructors

• constructor

Properties

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

Methods

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

Constructors

constructor

• new PuppeteerController(browserPlugin: BrowserPlugin<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>): PuppeteerController

• Inherited from BrowserController.constructor

  Parameters

  • browserPlugin: BrowserPlugin<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>

  Returns PuppeteerController

Properties

activePages

activePages: number = 0

Inherited from BrowserController.activePages

browser

browser: Browser = ...

Inherited from BrowserController.browser

Browser representation of the underlying automation library.

browserPlugin

browserPlugin: BrowserPlugin<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>

Inherited from BrowserController.browserPlugin

The BrowserPlugin instance used to launch the browser.

id

id: string = ...

Inherited from BrowserController.id

isActive

isActive: boolean = false

Inherited from BrowserController.isActive

lastPageOpenedAt

lastPageOpenedAt: number = ...

Inherited from BrowserController.lastPageOpenedAt

launchContext

launchContext: LaunchContext<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page> = ...

Inherited from BrowserController.launchContext

The configuration the browser was launched with.

totalPages

totalPages: number = 0

Inherited from BrowserController.totalPages

staticexternaldefaultMaxListeners

defaultMaxListeners: number

Inherited from BrowserController.defaultMaxListeners

Methods

externaladdListener

• addListener<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.addListener

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

close

• 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>

externalemit

• emit<U>(event: U, ...args: Parameters<BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]>): boolean

• Inherited from BrowserController.emit

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externalrest...args: Parameters<BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]>

  Returns boolean

externaleventNames

• eventNames<U>(): U[]

• Inherited from BrowserController.eventNames

  Type parameters

  • U: BROWSER_CLOSED

  Returns U[]

getCookies

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

• Inherited from BrowserController.getCookies

  Parameters

  • page: Page

  Returns Promise<Cookie[]>

externalgetMaxListeners

• getMaxListeners(): number

• Inherited from BrowserController.getMaxListeners

  Returns number

kill

• kill(): Promise<void>

• Inherited from BrowserController.kill

  Immediately kills the browser process.

  Emits 'browserClosed' event.

  ---

  Returns Promise<void>

externallistenerCount

• listenerCount(type: BROWSER_CLOSED): number

• Inherited from BrowserController.listenerCount

  Parameters

  • externaltype: BROWSER_CLOSED

  Returns number

externallisteners

• listeners<U>(type: U): BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U][]

• Inherited from BrowserController.listeners

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U][]

normalizeProxyOptions

• normalizeProxyOptions(proxyUrl: undefined | string, pageOptions: any): Record<string, unknown>

• Overrides BrowserController.normalizeProxyOptions

  Parameters

  • proxyUrl: undefined | string

  • pageOptions: any

  Returns Record<string, unknown>

externaloff

• off<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.off

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

externalon

• on<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.on

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

externalonce

• once<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.once

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

externalprependListener

• prependListener<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.prependListener

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

externalprependOnceListener

• prependOnceListener<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.prependOnceListener

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

externalrawListeners

• rawListeners<U>(type: U): BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U][]

• Inherited from BrowserController.rawListeners

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U][]

externalremoveAllListeners

• removeAllListeners(event?: BROWSER_CLOSED): PuppeteerController

• Inherited from BrowserController.removeAllListeners

  Parameters

  • externaloptionalevent: BROWSER_CLOSED

  Returns PuppeteerController

externalremoveListener

• removeListener<U>(event: U, listener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]): PuppeteerController

• Inherited from BrowserController.removeListener

  Type parameters

  • U: BROWSER_CLOSED

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<__module, undefined | (LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions & { extraPrefsFirefox?: Record<string, unknown>; product?: Product }), Browser, undefined | ContextOptions, Page>[U]

  Returns PuppeteerController

setCookies

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

• Inherited from BrowserController.setCookies

  Parameters

  • page: Page

  • cookies: Cookie[]

  Returns Promise<void>

externalsetMaxListeners

• setMaxListeners(n: number): PuppeteerController

• Inherited from BrowserController.setMaxListeners

  Parameters

  • externaln: number

  Returns PuppeteerController