Skip to content

Commit 96d4dc1

Browse files
authored
docs: add backlink from WebSocket to WebSockeRoute (#34600)
1 parent f11f4a8 commit 96d4dc1

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/src/api/class-websocket.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# class: WebSocket
22
* since: v1.8
33

4-
The [WebSocket] class represents websocket connections in the page.
4+
The [WebSocket] class represents WebSocket connections within a page. It provides the ability to inspect and manipulate the data being transmitted and received.
5+
6+
If you want to intercept or modify WebSocket frames, consider using [WebSocketRoute].
57

68
## event: WebSocket.close
79
* since: v1.8

packages/playwright-core/types/types.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21301,8 +21301,11 @@ export interface WebError {
2130121301
}
2130221302

2130321303
/**
21304-
* The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents websocket connections in the
21305-
* page.
21304+
* The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents WebSocket connections within a
21305+
* page. It provides the ability to inspect and manipulate the data being transmitted and received.
21306+
*
21307+
* If you want to intercept or modify WebSocket frames, consider using
21308+
* [WebSocketRoute](https://playwright.dev/docs/api/class-websocketroute).
2130621309
*/
2130721310
export interface WebSocket {
2130821311
/**

0 commit comments

Comments
 (0)