abstractBrowserPlugin <Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>
Hierarchy
- BrowserPlugin
Index
Constructors
constructor
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
library: Library
options: BrowserPluginOptions<LibraryOptions> = {}
Returns BrowserPlugin<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>
Properties
optionalbrowserPerProxy
experimentalContainers
launchOptions
library
name
optionalproxyUrl
useIncognitoPages
optionaluserDataDir
Methods
createController
Returns BrowserController<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>
createLaunchContext
Creates a
LaunchContext
with all the information needed to launch a browser. Aside from library specific launch options, it also includes internal properties used byBrowserPool
for management of the pool and extra features.Parameters
options: CreateLaunchContextOptions<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult> = {}
Returns LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>
launch
Launches the browser using provided launch context.
Parameters
launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult> = ...
Returns Promise<LaunchResult>
The
BrowserPlugin
serves two purposes. First, it is the base class that specialized controllers likePuppeteerPlugin
orPlaywrightPlugin
extend. Second, it allows the user to configure the automation libraries and feed them to BrowserPool for use.