abstractBrowserController <Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>

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

• TypedEmitter<BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>>
  • BrowserController
    • PuppeteerController
    • PlaywrightController

Implements

• IBrowserController<NewPageResult>

Index

Properties

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

Methods

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

Properties

activePages

activePages: number = 0

browser

browser: LaunchResult = ...

Implementation of IBrowserController.browser

Browser representation of the underlying automation library.

readonlybrowserPlugin

browserPlugin: BrowserPlugin<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>

The BrowserPlugin instance used to launch the browser.

readonlyid

id: string = ...

Implementation of IBrowserController.id

A stable identifier for this controller instance. Useful for tracking which browser served which request.

isActive

isActive: boolean = false

lastPageOpenedAt

lastPageOpenedAt: number = ...

launchContext

launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult> = ...

Implementation of IBrowserController.launchContext

The configuration the browser was launched with.

optionalproxyUrl

proxyUrl?: string

The proxy URL used by the browser controller. undefined if no proxy is used

totalPages

totalPages: number = 0

staticexternalinheriteddefaultMaxListeners

defaultMaxListeners: number

Inherited from TypedEmitter.defaultMaxListeners

Methods

externalinheritedaddListener

• addListener<U>(event, listener): this

• Inherited from TypedEmitter.addListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

close

• close(): Promise<void>

• Implementation of IBrowserController.close

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

  Emits 'browserClosed' event.

  ---

  Returns Promise<void>

externalinheritedemit

• emit<U>(event, ...args): boolean

• Inherited from TypedEmitter.emit

  Parameters

  • externalevent: U

  • externalrest...args: Parameters<BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]>

  Returns boolean

externalinheritedeventNames

• eventNames<U>(): U[]

• Inherited from TypedEmitter.eventNames

  Returns U[]

getCookies

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

• Implementation of IBrowserController.getCookies

  Reads cookies for the given page.

  ---

  Parameters

  • page: NewPageResult

  Returns Promise<Cookie[]>

externalinheritedgetMaxListeners

• getMaxListeners(): number

• Inherited from TypedEmitter.getMaxListeners

  Returns number

kill

• kill(): Promise<void>

• Immediately kills the browser process.

  Emits 'browserClosed' event.

  ---

  Returns Promise<void>

externalinheritedlistenerCount

• listenerCount(type): number

• Inherited from TypedEmitter.listenerCount

  Parameters

  • externaltype: BROWSER_CLOSED

  Returns number

externalinheritedlisteners

• listeners<U>(type): BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U][]

• Inherited from TypedEmitter.listeners

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U][]

externalinheritedoff

• off<U>(event, listener): this

• Inherited from TypedEmitter.off

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

externalinheritedon

• on<U>(event, listener): this

• Inherited from TypedEmitter.on

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

externalinheritedonce

• once<U>(event, listener): this

• Inherited from TypedEmitter.once

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

externalinheritedprependListener

• prependListener<U>(event, listener): this

• Inherited from TypedEmitter.prependListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

externalinheritedprependOnceListener

• prependOnceListener<U>(event, listener): this

• Inherited from TypedEmitter.prependOnceListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

externalinheritedrawListeners

• rawListeners<U>(type): BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U][]

• Inherited from TypedEmitter.rawListeners

  Parameters

  • externaltype: U

  Returns BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U][]

externalinheritedremoveAllListeners

• removeAllListeners(event): this

• Inherited from TypedEmitter.removeAllListeners

  Parameters

  • externaloptionalevent: BROWSER_CLOSED

  Returns this

externalinheritedremoveListener

• removeListener<U>(event, listener): this

• Inherited from TypedEmitter.removeListener

  Parameters

  • externalevent: U

  • externallistener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]

  Returns this

setCookies

• setCookies(page, cookies): Promise<void>

• Implementation of IBrowserController.setCookies

  Writes cookies for the given page.

  ---

  Parameters

  • page: NewPageResult

  • cookies: Cookie[]

  Returns Promise<void>

externalinheritedsetMaxListeners

• setMaxListeners(n): this

• Inherited from TypedEmitter.setMaxListeners

  Parameters

  • externaln: number

  Returns this

waitForActive

• waitForActive(): Promise<void>

• Returns a promise that resolves once the browser controller has been activated.

  ---

  Returns Promise<void>