Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

docs(api): fix examples that call nonexistent APIs (#43393)

Super-Eric9690e49c999e
diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md
index c3fe90f395..2c0acaa7b2 100644
--- a/docs/src/api/class-browsercontext.md
+++ b/docs/src/api/class-browsercontext.md
@@ -1303,61 +1303,61 @@ Below is an example of a simple handler that blocks some websocket messages.
See [WebSocketRoute] for more details and examples.
```js
-await context.routeWebSocket('/ws', async ws => {
- ws.routeSend(message => {
+await context.routeWebSocket('/ws', ws => {
+ const server = ws.connectToServer();
+ ws.onMessage(message => {
if (message === 'to-be-blocked')
return;
- ws.send(message);
+ server.send(message);
});
- await ws.connect();
});
```
```java
context.routeWebSocket("/ws", ws -> {
- ws.routeSend(message -> {
- if ("to-be-blocked".equals(message))
+ WebSocketRoute server = ws.connectToServer();
+ ws.onMessage(frame -> {
+ if ("to-be-blocked".equals(frame.text()))
return;
- ws.send(message);
+ server.send(frame.text());
});
- ws.connect();
});
```
```python async
-def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
+def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
if message == "to-be-blocked":
return
- ws.send(message)
+ server.send(message)
-async def handler(ws: WebSocketRoute):
- ws.route_send(lambda message: message_handler(ws, message))
- await ws.connect()
+def handler(ws: WebSocketRoute):
+ server = ws.connect_to_server()
+ ws.on_message(lambda message: message_handler(server, message))
await context.route_web_socket("/ws", handler)
```
```python sync
-def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
+def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
if message == "to-be-blocked":
return
- ws.send(message)
+ server.send(message)
def handler(ws: WebSocketRoute):
- ws.route_send(lambda message: message_handler(ws, message))
- ws.connect()
+ server = ws.connect_to_server()
+ ws.on_message(lambda message: message_handler(server, message))
context.route_web_socket("/ws", handler)
```
```csharp
-await context.RouteWebSocketAsync("/ws", async ws => {
- ws.RouteSend(message => {
- if (message == "to-be-blocked")
+await context.RouteWebSocketAsync("/ws", ws => {
+ var server = ws.ConnectToServer();
+ ws.OnMessage(frame => {
+ if (frame.Text == "to-be-blocked")
return;
- ws.Send(message);
+ server.Send(frame.Text);
});
- await ws.ConnectAsync();
});
```
diff --git a/docs/src/api/class-frame.md b/docs/src/api/class-frame.md
index 379fa718ed..80c489de99 100644
--- a/docs/src/api/class-frame.md
+++ b/docs/src/api/class-frame.md
@@ -1596,7 +1596,7 @@ frame.selectOption('select#colors', 'blue');
frame.selectOption('select#colors', { label: 'Blue' });
// multiple selection
-frame.selectOption('select#colors', 'red', 'green', 'blue');
+frame.selectOption('select#colors', ['red', 'green', 'blue']);
```
```java
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
index d055e2a71b..05d44e7c12 100644
--- a/docs/src/api/class-page.md
+++ b/docs/src/api/class-page.md
@@ -4067,10 +4067,11 @@ Handler function to route the WebSocket.
**Usage**
```js
-page.screencast.on('screencastFrame', data => {
- console.log('received frame, jpeg size:', data.length);
+await page.screencast.start({
+ onFrame: ({ data }) => {
+ console.log('received frame, jpeg size:', data.length);
+ },
});
-await page.screencast.start();
// ... perform actions ...
await page.screencast.stop();
```
diff --git a/docs/src/test-api/class-testconfig.md b/docs/src/test-api/class-testconfig.md
index c73705f1d6..c26545cc18 100644
--- a/docs/src/test-api/class-testconfig.md
+++ b/docs/src/test-api/class-testconfig.md
@@ -821,7 +821,7 @@ export default defineConfig({
```js
import { test, expect } from '@playwright/test';
-test.use({ baseUrl: `http://localhost:${process.env.MY_SERVER_PORT ?? 3000}` });
+test.use({ baseURL: `http://localhost:${process.env.MY_SERVER_PORT ?? 3000}` });
test('homepage', async ({ page }) => {
await page.goto('/');
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index ccf7297f56..898bed827b 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -5878,10 +5878,11 @@ export interface Page {
* **Usage**
*
* ```js
- * page.screencast.on('screencastFrame', data => {
- * console.log('received frame, jpeg size:', data.length);
+ * await page.screencast.start({
+ * onFrame: ({ data }) => {
+ * console.log('received frame, jpeg size:', data.length);
+ * },
* });
- * await page.screencast.start();
* // ... perform actions ...
* await page.screencast.stop();
* ```
@@ -8420,7 +8421,7 @@ export interface Frame {
* frame.selectOption('select#colors', { label: 'Blue' });
*
* // multiple selection
- * frame.selectOption('select#colors', 'red', 'green', 'blue');
+ * frame.selectOption('select#colors', ['red', 'green', 'blue']);
* ```
*
* @param selector A selector to query for.
@@ -10527,13 +10528,13 @@ export interface BrowserContext {
* [WebSocketRoute](https://playwright.dev/docs/api/class-websocketroute) for more details and examples.
*
* ```js
- * await context.routeWebSocket('/ws', async ws => {
- * ws.routeSend(message => {
+ * await context.routeWebSocket('/ws', ws => {
+ * const server = ws.connectToServer();
+ * ws.onMessage(message => {
* if (message === 'to-be-blocked')
* return;
- * ws.send(message);
+ * server.send(message);
* });
- * await ws.connect();
* });
* ```
*
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index ccf7297f56..898bed827b 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -5878,10 +5878,11 @@ export interface Page {
* **Usage**
*
* ```js
- * page.screencast.on('screencastFrame', data => {
- * console.log('received frame, jpeg size:', data.length);
+ * await page.screencast.start({
+ * onFrame: ({ data }) => {
+ * console.log('received frame, jpeg size:', data.length);
+ * },
* });
- * await page.screencast.start();
* // ... perform actions ...
* await page.screencast.stop();
* ```
@@ -8420,7 +8421,7 @@ export interface Frame {
* frame.selectOption('select#colors', { label: 'Blue' });
*
* // multiple selection
- * frame.selectOption('select#colors', 'red', 'green', 'blue');
+ * frame.selectOption('select#colors', ['red', 'green', 'blue']);
* ```
*
* @param selector A selector to query for.
@@ -10527,13 +10528,13 @@ export interface BrowserContext {
* [WebSocketRoute](https://playwright.dev/docs/api/class-websocketroute) for more details and examples.
*
* ```js
- * await context.routeWebSocket('/ws', async ws => {
- * ws.routeSend(message => {
+ * await context.routeWebSocket('/ws', ws => {
+ * const server = ws.connectToServer();
+ * ws.onMessage(message => {
* if (message === 'to-be-blocked')
* return;
- * ws.send(message);
+ * server.send(message);
* });
- * await ws.connect();
* });
* ```
*
diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts
index 43fe8285a3..810f31340c 100644
--- a/packages/playwright/types/test.d.ts
+++ b/packages/playwright/types/test.d.ts
@@ -1084,7 +1084,7 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
* ```js
* import { test, expect } from '@playwright/test';
*
- * test.use({ baseUrl: `http://localhost:${process.env.MY_SERVER_PORT ?? 3000}` });
+ * test.use({ baseURL: `http://localhost:${process.env.MY_SERVER_PORT ?? 3000}` });
*
* test('homepage', async ({ page }) => {
* await page.goto('/');