Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryo-ma/deno-websocket
🦕 A simple WebSocket library like ws of node.js library for deno
https://github.com/ryo-ma/deno-websocket
deno deno-websocket rfc-6455 typescript websocket websocket-client websocket-library websocket-server ws
Last synced: 3 days ago
JSON representation
🦕 A simple WebSocket library like ws of node.js library for deno
- Host: GitHub
- URL: https://github.com/ryo-ma/deno-websocket
- Owner: ryo-ma
- License: mit
- Created: 2020-05-17T14:45:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T03:42:10.000Z (almost 2 years ago)
- Last Synced: 2025-02-16T07:56:30.640Z (5 days ago)
- Topics: deno, deno-websocket, rfc-6455, typescript, websocket, websocket-client, websocket-library, websocket-server, ws
- Language: TypeScript
- Homepage: https://deno.land/x/websocket
- Size: 62.5 KB
- Stars: 153
- Watchers: 2
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deno-cn - @ryo-ma/deno-websocket - 🦕 一个简单的 WebSocket 库，例如 node.js 库的 ws。 (基础设施 / Deno 源)
- awesome-deno - deno-websocket - 🦕 A simple WebSocket library like ws of node.js library. (Modules / WebSocket)
- awesome-deno - deno-websocket - 🦕A simple WebSocket library like ws of node.js library. (Modules / Online Playgrounds)
README
# deno websocket
[](https://doc.deno.land/https/deno.land/x/denon/mod.ts)
[](https://nest.land/package/deno-websocket)
🦕 A simple WebSocket library like [ws of node.js library](https://github.com/websockets/ws) for deno
This library is wrapping the [ws standard library](https://github.com/denoland/deno_std/tree/main/ws) as a server-side and the [native WebSocket API](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) as a client-side.
You can receive callbacks at the EventEmitter and can use the same object format on both the server-side and the client-side.
* Deno >= 1.8.3
# Quick Start
## Example Demo
Server side
```bash
$ deno run --allow-net https://deno.land/x/[email protected]/example/server.ts
```
Client side
```bash
$ deno run --allow-net https://deno.land/x/[email protected]/example/client.ts
ws connected! (type 'close' to quit)
> something
```
## Usage
Server side
```typescript
import { WebSocketClient, WebSocketServer } from "https://deno.land/x/[email protected]/mod.ts";
const wss = new WebSocketServer(8080);
wss.on("connection", function (ws: WebSocketClient) {
ws.on("message", function (message: string) {
console.log(message);
ws.send(message);
});
});
```
Client side
```typescript
import { WebSocketClient, StandardWebSocketClient } from "https://deno.land/x/[email protected]/mod.ts";
const endpoint = "ws://127.0.0.1:8080";
const ws: WebSocketClient = new StandardWebSocketClient(endpoint);
ws.on("open", function() {
console.log("ws connected!");
ws.send("something");
});
ws.on("message", function (message: string) {
console.log(message);
});
```
# 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\ |
### Method
| method | detail |
| --- | --- |
| close() | Close the server |
## WebSocketClient
### 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.isClosed | 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](./LICENSE)