@ont-community/html5-websocket

HTML5 WebSocket for node.js

Usage no npm install needed!

<script type="module">
  import ontCommunityHtml5Websocket from 'https://cdn.skypack.dev/@ont-community/html5-websocket';
</script>

README

html5-websocket

This module implements the standard HTML5 WebSocket API as a thin layer over the great ws library.

The motivation behind this module is to be able to write WebSocket based libraries that will run without changes in Node.js, Browsers or React Native apps.

Install

npm install --save @ont-community/html5-websocket

Usage

The API is the same as the standard HTML5 Socket API so nothing new here...

const WebSocket = require('@ont-community/html5-websocket');

const ws = new WebSocket('ws://html5rocks.websocket.org/echo');

ws.onopen = function () {
    ws.send('Hello!');
};

ws.onmessage = function (e) {
    console.log(e.data);
};

ws.onerror = function (error) {
    console.log('Fail:', error);
};

You can also use the DOM Level 2 Event Model

const handleMessage = function (e) {
    console.log(e.data);
};

// add listener
ws.addEventListener('message', handleMessage);

// remove listener
ws.removeEventListener('message', handleMessage);

License

MIT