Home > @rushstack/playwright-browser-tunnel > createTunneledBrowserAsync

createTunneledBrowserAsync() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates a Playwright Browser instance connected via a tunneled WebSocket connection.

Signature:

export declare function createTunneledBrowserAsync(browserName: BrowserName, launchOptions: LaunchOptions, logger?: ITerminal, port?: number): Promise<IDisposableTunneledBrowser>;

Parameters

Parameter	Type	Description
browserName	BrowserName
launchOptions	LaunchOptions
logger	ITerminal	(Optional)
port	number	(Optional)

Returns:

Promise<IDisposableTunneledBrowser>