deno websocket

GitHub

🦕 A simple WebSocket library like ws of node.js library for deno

Quick Start

Example Demo

demo

Server side

$ deno run --allow-net https://deno.land/x/websocket/example/server.ts

Client side

$ deno run --allow-net https://deno.land/x/websocket/example/client.ts 
ws connected! (type 'close' to quit)
> something

Usage

Server side

import { WebSocket, WebSocketServer } from "https://deno.land/x/websocket/mod.ts";

const wss = new WebSocketServer(8080);
wss.on("connection", function (ws: WebSocket) {
  ws.on("message", function (message: string) {
    console.log(message);
    ws.send(message)
  });
});

Client side

import { WebSocket } from "https://deno.land/x/websocket/mod.ts";
const endpoint = "ws://127.0.0.1:8080";
const ws: WebSocket = new WebSocket(endpoint);
ws.on("open", function() {
  console.log("ws connected!");
});
ws.on("message", function (message: string) {
  console.log(message);
});
ws.send("something");

Documentation

WebSocketServer

Event

event	detail
connection	Emitted when the handshake is complete
error	Emitted when an error occurs

Field

field	detail	type
server.clients	A set that stores all connected clients	Set<WebSocket>

Method

method	detail
close()	Close the server

WebSocket

Event

event	detail
open	Emitted when the connection is established
close	Emitted when the connection is closed
message	Emitted when a message is received from the server
ping	Emitted when a ping is received from the server
pong	Emitted when a pong is received from the server
error	Emitted when an error occurs

Field

field	detail	type
websocket.isClose	Get the close flag	Boolean \| undefined

Method

method	detail
send(message:string \| Unit8Array)	Send a message
ping(message:string \| Unit8Array)	Send the ping
close([code:int[, reason:string]])	Close the connection with the server
forceClose()	Forcibly close the connection with the server

LICENSE

MIT LICENSE