Skip to main content
Version: Next

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.

@hideconstructor

Hierarchy

Index

Constructors

constructor

  • new BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>(browserPlugin: BrowserPlugin<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>
  • Type parameters

    • Library: CommonLibrary = CommonLibrary
    • LibraryOptions: undefined | Dictionary = Parameters<Library[launch]>[0]
    • LaunchResult: CommonBrowser = UnwrapPromise<ReturnType<Library[launch]>>
    • NewPageOptions = Parameters<LaunchResult[newPage]>[0]
    • NewPageResult = UnwrapPromise<ReturnType<LaunchResult[newPage]>>

    Parameters

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

    Returns BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>

Properties

activePages

activePages: number = 0

browser

browser: LaunchResult = ...

Browser representation of the underlying automation library.

browserPlugin

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

The BrowserPlugin instance used to launch the browser.

id

id: string = ...

isActive

isActive: boolean = false

lastPageOpenedAt

lastPageOpenedAt: number = ...

launchContext

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

The configuration the browser was launched with.

optionalproxyTier

proxyTier?: number

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

optionalproxyUrl

proxyUrl?: string

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

totalPages

totalPages: number = 0

staticexternaldefaultMaxListeners

defaultMaxListeners: number

Methods

externaladdListener

  • addListener<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

close

  • close(): Promise<void>
  • 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<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]>): boolean
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns boolean

externaleventNames

  • eventNames<U>(): U[]
  • Type parameters

    • U: BROWSER_CLOSED

    Returns U[]

getCookies

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

    • page: NewPageResult

    Returns Promise<Cookie[]>

externalgetMaxListeners

  • getMaxListeners(): number
  • Returns number

kill

  • kill(): Promise<void>
  • Immediately kills the browser process.

    Emits 'browserClosed' event.


    Returns Promise<void>

externallistenerCount

  • listenerCount(type: BROWSER_CLOSED): number
  • Parameters

    • externaltype: BROWSER_CLOSED

    Returns number

externallisteners

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

    • U: BROWSER_CLOSED

    Parameters

    • externaltype: U

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

externaloff

  • off<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

externalon

  • on<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

externalonce

  • once<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

externalprependListener

  • prependListener<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

externalprependOnceListener

  • prependOnceListener<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

externalrawListeners

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

    • U: BROWSER_CLOSED

    Parameters

    • externaltype: U

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

externalremoveAllListeners

  • removeAllListeners(event?: BROWSER_CLOSED): this
  • Parameters

    • externaloptionalevent: BROWSER_CLOSED

    Returns this

externalremoveListener

  • removeListener<U>(event: U, listener: BrowserControllerEvents<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>[U]): this
  • Type parameters

    • U: BROWSER_CLOSED

    Parameters

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

    Returns this

setCookies

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

    • page: NewPageResult
    • cookies: Cookie[]

    Returns Promise<void>

externalsetMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • externaln: number

    Returns this