This package has been deprecated

Author message:

Miniflare v2 is no longer supported. Please upgrade to Miniflare v4

@miniflare/web-sockets

WebSocket module for Miniflare: a fun, full-featured, fully-local simulator for Cloudflare Workers. See ✉️ WebSockets for more details.

Example

import StandardWebSocket from "ws";
import { WebSocketPair, coupleWebSocket } from "@miniflare/web-sockets";

const [webSocket1, webSocket2] = Object.values(new WebSocketPair());

// Manually accept the first WebSocket
webSocket1.accept();
webSocket1.addEventListener("message", (event) => {
  console.log(event.data);
});
webSocket1.send("hello");

// Couple (forward messages from/to) the second WebSocket with a real WebSocket
const ws = new StandardWebSocket("ws://...");
coupleWebSocket(ws, webSocket2);