docs: add backlink from WebSocket to WebSockeRoute (#34600)

microsoft · Feb 3, 2025 · 96d4dc1 · 96d4dc1
1 parent f11f4a8
commit 96d4dc1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/docs/src/api/class-websocket.md b/docs/src/api/class-websocket.md
@@ -1,7 +1,9 @@
 # class: WebSocket
 * since: v1.8
 
-The [WebSocket] class represents websocket connections in the page.
+The [WebSocket] class represents WebSocket connections within a page. It provides the ability to inspect and manipulate the data being transmitted and received.
+
+If you want to intercept or modify WebSocket frames, consider using [WebSocketRoute].
 
 ## event: WebSocket.close
 * since: v1.8

diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -21301,8 +21301,11 @@ export interface WebError {
 }
 
 /**
- * The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents websocket connections in the
- * page.
+ * The [WebSocket](https://playwright.dev/docs/api/class-websocket) class represents WebSocket connections within a
+ * page. It provides the ability to inspect and manipulate the data being transmitted and received.
+ *
+ * If you want to intercept or modify WebSocket frames, consider using
+ * [WebSocketRoute](https://playwright.dev/docs/api/class-websocketroute).
  */
 export interface WebSocket {
   /**