BREAKING(unstable): Rename Deno.WebSocketUpgrade::websocket to socket (…

…denoland#11542)
unibg-seclab · Jul 28, 2021 · 42afbed · 42afbed
1 parent c198535
commit 42afbed
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 17 deletions.
diff --git a/cli/tests/unit/http_test.ts b/cli/tests/unit/http_test.ts
@@ -641,12 +641,12 @@ unitTest({ perms: { net: true } }, async function httpServerWebSocket() {
  const { request, respondWith } = (await httpConn.nextRequest())!;
  const {
  response,
- websocket,
+ socket,
  } = Deno.upgradeWebSocket(request);
- websocket.onerror = () => fail();
- websocket.onmessage = (m) => {
- websocket.send(m.data);
- websocket.close();
+ socket.onerror = () => fail();
+ socket.onmessage = (m) => {
+ socket.send(m.data);
+ socket.close();
  };
  await respondWith(response);
  break;

diff --git a/extensions/http/01_http.js b/extensions/http/01_http.js
@@ -368,11 +368,11 @@
 
  const response = fromInnerResponse(r, "immutable");
 
- const websocket = webidl.createBranded(WebSocket);
- setEventTargetData(websocket);
- response[_ws] = websocket;
+ const socket = webidl.createBranded(WebSocket);
+ setEventTargetData(socket);
+ response[_ws] = socket;
 
- return { response, websocket };
+ return { response, socket };
  }
 
  window.__bootstrap.http = {

diff --git a/extensions/http/lib.deno_http.unstable.d.ts b/extensions/http/lib.deno_http.unstable.d.ts
@@ -18,7 +18,7 @@ declare namespace Deno {
 
  export interface WebSocketUpgrade {
  response: Response;
- websocket: WebSocket;
+ socket: WebSocket;
  }
 
  export interface UpgradeWebSocketOptions {
@@ -38,16 +38,16 @@ declare namespace Deno {
  * const httpConn = Deno.serveHttp(conn);
  * const e = await httpConn.nextRequest();
  * if (e) {
- * const { websocket, response } = Deno.upgradeWebSocket(e.request);
- * websocket.onopen = () => {
- * websocket.send("Hello World!");
+ * const { socket, response } = Deno.upgradeWebSocket(e.request);
+ * socket.onopen = () => {
+ * socket.send("Hello World!");
  * };
- * websocket.onmessage = (e) => {
+ * socket.onmessage = (e) => {
  * console.log(e.data);
- * websocket.close();
+ * socket.close();
  * };
- * websocket.onclose = () => console.log("WebSocket has been closed.");
- * websocket.onerror = (e) => console.error("WebSocket error:", e.message);
+ * socket.onclose = () => console.log("WebSocket has been closed.");
+ * socket.onerror = (e) => console.error("WebSocket error:", e.message);
  * e.respondWith(response);
  * }
  * ```