RemotePlaywrightPlugin

A PlaywrightPlugin that connects to a remote browser service (Browserbase, Browserless, Steel, …) instead of launching locally. launchOptions are ignored — the remote service owns the browser.

Remote connections only support incognito pages (connect() / connectOverCDP() don't accept persistent contexts), so useIncognitoPages is always true.

Hierarchy

• PlaywrightPlugin
  • RemotePlaywrightPlugin

Index

Constructors

• constructor

Properties

• browserPerProxy
• ignoreProxyCertificate
• launchOptions
• library
• name
• proxyUrl
• useIncognitoPages
• userDataDir

Methods

• createController
• createLaunchContext
• launch

Constructors

constructor

• new RemotePlaywrightPlugin(library, options): RemotePlaywrightPlugin

• Overrides PlaywrightPlugin.constructor

  Parameters

  • library: BrowserType<{}>

  • options: RemotePlaywrightPluginOptions

  Returns RemotePlaywrightPlugin

Properties

optionalreadonlyinheritedbrowserPerProxy

browserPerProxy?: boolean

Inherited from PlaywrightPlugin.browserPerProxy

optionalreadonlyinheritedignoreProxyCertificate

ignoreProxyCertificate?: boolean

Inherited from PlaywrightPlugin.ignoreProxyCertificate

readonlyinheritedlaunchOptions

launchOptions: undefined | LaunchOptions

Inherited from PlaywrightPlugin.launchOptions

readonlyinheritedlibrary

library: BrowserType<{}>

Inherited from PlaywrightPlugin.library

readonlyinheritedname

name: string = ...

Inherited from PlaywrightPlugin.name

optionalreadonlyinheritedproxyUrl

proxyUrl?: string

Inherited from PlaywrightPlugin.proxyUrl

inheriteduseIncognitoPages

useIncognitoPages: boolean

Inherited from PlaywrightPlugin.useIncognitoPages

optionalreadonlyinheriteduserDataDir

userDataDir?: string

Inherited from PlaywrightPlugin.userDataDir

Methods

inheritedcreateController

• createController(): PlaywrightController

• Inherited from PlaywrightPlugin.createController

  Returns PlaywrightController

createLaunchContext

• createLaunchContext(options): LaunchContext<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer<ArrayBufferLike>; certPath?: string; key?: Buffer<ArrayBufferLike>; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer<ArrayBufferLike>; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; contrast?: null | no-preference | more; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string } | { origin?: string; password: string; send?: unauthorized | always; username: string }[]; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir?: string; fps?: number; showActions?: { cursor?: none | pointer; duration?: number; fontSize?: number; position?: top-left | top | top-right | bottom-left | bottom | bottom-right; style?: { highlight?: string; point?: string; title?: string } }; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; viewport?: null | { height: number; width: number } }, Page>

• Overrides PlaywrightPlugin.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 by BrowserPool for management of the pool and extra features.

  ---

  Parameters

  • options: CreateLaunchContextOptions<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer<ArrayBufferLike>; certPath?: string; key?: Buffer<ArrayBufferLike>; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer<ArrayBufferLike>; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; contrast?: null | no-preference | more; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string } | { origin?: string; password: string; send?: unauthorized | always; username: string }[]; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir?: string; fps?: number; showActions?: { cursor?: none | pointer; duration?: number; fontSize?: number; position?: top-left | top | top-right | bottom-left | bottom | bottom-right; style?: { highlight?: string; point?: string; title?: string } }; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; viewport?: null | { height: number; width: number } }, Page> = {}

  Returns LaunchContext<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer<ArrayBufferLike>; certPath?: string; key?: Buffer<ArrayBufferLike>; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer<ArrayBufferLike>; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; contrast?: null | no-preference | more; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string } | { origin?: string; password: string; send?: unauthorized | always; username: string }[]; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir?: string; fps?: number; showActions?: { cursor?: none | pointer; duration?: number; fontSize?: number; position?: top-left | top | top-right | bottom-left | bottom | bottom-right; style?: { highlight?: string; point?: string; title?: string } }; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; viewport?: null | { height: number; width: number } }, Page>

launch

• launch(launchContext): Promise<Browser>

• Overrides PlaywrightPlugin.launch

  Skips the local proxy and webdriver-stealth preparation; the remote service owns the browser.

  ---

  Parameters

  • launchContext: LaunchContext<BrowserType<{}>, undefined | LaunchOptions, Browser, undefined | { acceptDownloads?: boolean; baseURL?: string; bypassCSP?: boolean; clientCertificates?: { cert?: Buffer<ArrayBufferLike>; certPath?: string; key?: Buffer<ArrayBufferLike>; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer<ArrayBufferLike>; pfxPath?: string }[]; colorScheme?: null | light | dark | no-preference; contrast?: null | no-preference | more; deviceScaleFactor?: number; extraHTTPHeaders?: {}; forcedColors?: null | active | none; geolocation?: { accuracy?: number; latitude: number; longitude: number }; hasTouch?: boolean; httpCredentials?: { origin?: string; password: string; send?: unauthorized | always; username: string } | { origin?: string; password: string; send?: unauthorized | always; username: string }[]; ignoreHTTPSErrors?: boolean; isMobile?: boolean; javaScriptEnabled?: boolean; locale?: string; logger?: Logger; offline?: boolean; permissions?: string[]; proxy?: { bypass?: string; password?: string; server: string; username?: string }; recordHar?: { content?: omit | embed | attach; mode?: full | minimal; omitContent?: boolean; path: string; urlFilter?: string | RegExp }; recordVideo?: { dir?: string; fps?: number; showActions?: { cursor?: none | pointer; duration?: number; fontSize?: number; position?: top-left | top | top-right | bottom-left | bottom | bottom-right; style?: { highlight?: string; point?: string; title?: string } }; size?: { height: number; width: number } }; reducedMotion?: null | reduce | no-preference; screen?: { height: number; width: number }; serviceWorkers?: allow | block; storageState?: string | { cookies: { domain: string; expires: number; httpOnly: boolean; name: string; path: string; sameSite: Strict | Lax | None; secure: boolean; value: string }[]; origins: { localStorage: { name: string; value: string }[]; origin: string }[] }; strictSelectors?: boolean; timezoneId?: string; userAgent?: string; viewport?: null | { height: number; width: number } }, Page> = ...

  Returns Promise<Browser>