yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: be more clear about connect/launchServer version match (#16134)

Browse Source
This commit is contained in:
Max Schmitt 2022-08-02 18:59:42 +02:00 committed by GitHub
parent 153670978d
commit b34da61524
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/api/class-browsertype.md
View File

@ -89,7 +89,7 @@ class BrowserTypeExamples
* since: v1.8
- returns: <[Browser]>
This method attaches Playwright to an existing browser instance.
This method attaches Playwright to an existing browser instance. When connecting to another browser launched via `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x).
### param: BrowserType.connect.wsEndpoint
* since: v1.10
@ -283,7 +283,7 @@ use a temporary directory instead.
* langs: js
- returns: <[BrowserServer]>
Returns the browser app instance.
Returns the browser app instance. You can connect to it via [`method: BrowserType.connect`], which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x).
Launches browser server that client can connect to. An example of launching a browser executable and connecting to it
later:

12
packages/playwright-core/types/types.d.ts vendored
View File

@ -10379,7 +10379,9 @@ export interface BrowserType<Unused = {}> {
*/
connectOverCDP(options: ConnectOverCDPOptions & { wsEndpoint?: string }): Promise<Browser>;
/**
* This method attaches Playwright to an existing browser instance.
* This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
* `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is
* compatible with 1.2.x).
* @param wsEndpoint A browser websocket endpoint to connect to.
* @param options
*/
@ -10391,7 +10393,9 @@ export interface BrowserType<Unused = {}> {
* @deprecated
*/
/**
* This method attaches Playwright to an existing browser instance.
* This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
* `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is
* compatible with 1.2.x).
* @param wsEndpoint A browser websocket endpoint to connect to.
* @param options
*/
@ -10835,7 +10839,9 @@ export interface BrowserType<Unused = {}> {
}): Promise<BrowserContext>;
/**
* Returns the browser app instance.
* Returns the browser app instance. You can connect to it via
* [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect),
* which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x).
*
* Launches browser server that client can connect to. An example of launching a browser executable and connecting to it
* later: