promise-ws


A promise based WebSocket implementation for Node.js. Built on top of ws

Table of Contents

- Table of Contents
- Usage examples
- Simple client
- Simple server
- Installation
- API Reference
- License

Usage examples

$3

``js
import WebSocket from "promise-ws";

(async function() {
const ws = await WebSocket.create("ws://www.host.com/path");

ws.on("message", function incoming(data) {
console.log(data);
});

await ws.send("something");
})();
`

$3

`js
import WebSocket from "promise-ws";

(async function() {
const wss = await WebSocket.Server.create({ port: 8080 });

wss.on("connection", async function connection(ws) {
ws.on("message", function incoming(message) {
console.log("received: %s", message);
});

await ws.send("something");
});
})();
`

Installation

`bash
$ npm install promise-ws
`

API Reference

promise-ws API is almost the same with ws except that:

- websocket.ping([data[, mask]]) returns a promise
- websocket.pong([data[, mask]]) returns a promise
- websocket.send(data[, options]) returns a promise
- 🆕 WebSocket.Server.create(options), returns a promise of listened WebSocket.Server instance
- 🆕 WebSocket.create(options), returns a promise of opened WebSocket` instance

For more WebSocket API, please checkout the API doc.

License

MIT