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

Indexable

[K: PropertyKey]: unknown

Index

Constructors

• constructor

Properties

• browserPerProxy
• browserPlugin
• experimentalContainers
• fingerprint
• id
• launchOptions
• proxyTier
• useIncognitoPages
• userDataDir

Accessors

• proxyUrl

Methods

• extend

Constructors

constructor

• new LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>(options: LaunchContextOptions<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): LaunchContext<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

  • options: LaunchContextOptions<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>

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

Properties

optionalbrowserPerProxy

browserPerProxy?: boolean

browserPlugin

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

experimentalContainers

experimentalContainers: boolean

optionalfingerprint

fingerprint?: BrowserFingerprintWithHeaders

optionalid

id?: string

launchOptions

launchOptions: LibraryOptions

optionalproxyTier

proxyTier?: number

useIncognitoPages

useIncognitoPages: boolean

userDataDir

userDataDir: string

Accessors

proxyUrl

• get proxyUrl(): undefined | string
• set proxyUrl(url: undefined | string): void

• Returns the proxy URL of the browser.

  ---

  Returns undefined | string

• Sets a proxy URL for the browser. Use undefined to unset existing proxy URL.

  ---

  Parameters

  • url: undefined | string

  Returns void

Methods

extend

• extend<T>(fields: T): void

• Extend the launch context with any extra fields. This is useful to keep state information relevant to the browser being launched. It ensures that no internal fields are overridden and should be used instead of property assignment.

  ---

  Type parameters

  • T: Record<PropertyKey, unknown>

  Parameters

  • fields: T

  Returns void