Skip to main content
Version: Next

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.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>
    • PuppeteerController

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

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

    Returns PuppeteerController

Properties

inheritedactivePages

activePages: number = 0

inheritedbrowser

browser: Browser = ...

Browser representation of the underlying automation library.

readonlyinheritedbrowserPlugin

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

The BrowserPlugin instance used to launch the browser.

readonlyinheritedid

id: string = ...

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

inheritedisActive

isActive: boolean = false

inheritedlastPageOpenedAt

lastPageOpenedAt: number = ...

inheritedlaunchContext

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

The configuration the browser was launched with.

optionalinheritedproxyUrl

proxyUrl?: string

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

inheritedtotalPages

totalPages: number = 0

staticexternalinheriteddefaultMaxListeners

defaultMaxListeners: number

Methods

externalinheritedaddListener

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

  • Parameters

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

    Returns this

inheritedclose

  • close(): Promise<void>

  • 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

  • Parameters

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

    Returns boolean

externalinheritedeventNames

  • eventNames<U>(): U[]

  • Returns U[]

inheritedgetCookies

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

  • Reads cookies for the given page.

    Parameters

    • page: Page

    Returns Promise<Cookie[]>

externalinheritedgetMaxListeners

  • getMaxListeners(): number

  • Returns number

inheritedkill

  • kill(): Promise<void>

  • Immediately kills the browser process.

    Emits 'browserClosed' event.

    Returns Promise<void>

externalinheritedlistenerCount

  • listenerCount(type): number

  • Parameters

    • externaltype: BROWSER_CLOSED

    Returns number

externalinheritedlisteners

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

  • Parameters

    • externaltype: U

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

externalinheritedoff

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

  • Parameters

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

    Returns this

externalinheritedon

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

  • Parameters

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

    Returns this

externalinheritedonce

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

  • Parameters

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

    Returns this

externalinheritedprependListener

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

  • Parameters

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

    Returns this

externalinheritedprependOnceListener

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

  • Parameters

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

    Returns this

externalinheritedrawListeners

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

  • Parameters

    • externaltype: U

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

externalinheritedremoveAllListeners

  • removeAllListeners(event): this

  • Parameters

    • externaloptionalevent: BROWSER_CLOSED

    Returns this

externalinheritedremoveListener

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

  • Parameters

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

    Returns this

inheritedsetCookies

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

  • Writes cookies for the given page.

    Parameters

    Returns Promise<void>

externalinheritedsetMaxListeners

  • setMaxListeners(n): this

  • Parameters

    • externaln: number

    Returns this

inheritedwaitForActive

  • waitForActive(): Promise<void>

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

    Returns Promise<void>

Page Options