Blockcore WebSocket (blockcore-ws) is a WebSocket library designed to provide an easy and seamless way to implement WebSocket communication in various environments. It supports both Node.js and browser environments, making it versatile for different use cases.
- 🚀 Easy to use API
- 🌍 Supports both Node.js and browser environments
- 💡 Lightweight and efficient
To install the blockcore-ws library, use the following npm command:
npm install @blockcore/wsHere is an example of how to use blockcore-ws in a Node.js environment:
-
Create a file named
app.jsand add the following code:import WebSocket from '@blockcore/ws'; const ws = new WebSocket('wss://echo.websocket.org'); ws.on('open', function open() { console.log('connected'); ws.send(Date.now()); }); ws.on('close', function close() { console.log('disconnected'); }); ws.on('message', function incoming(data) { console.log(`Roundtrip time: ${Date.now() - data} ms`); ws.send(Date.now()); });
-
Ensure your
package.jsonincludes"type": "module"to use ES modules:{ "name": "your-project-name", "version": "1.0.0", "description": "", "main": "app.js", "type": "module", "scripts": { "start": "node app.js" }, "dependencies": { "@blockcore/ws": "^0.0.1" } } -
Install dependencies and run the example:
npm install npm start
To use blockcore-ws in a browser environment, follow these steps:
-
Create an HTML file,
index.html, and include a script to run the WebSocket code:<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Blockcore WebSocket Example</title> </head> <body> <script type="module"> import WebSocket from './path/to/blockcore-ws/browser.js'; const ws = new WebSocket('wss://echo.websocket.org'); ws.onopen = () => { console.log('connected'); ws.send(Date.now()); }; ws.onclose = () => { console.log('disconnected'); }; ws.onmessage = (event) => { console.log(`Roundtrip time: ${Date.now() - event.data} ms`); ws.send(Date.now()); }; </script> </body> </html>
-
Serve the HTML file using a local server. You can use
http-serveror any other local server tool:npm install -g http-server http-server
-
Open the served HTML file in your browser to see the WebSocket in action.
The blockcore-ws library includes a Webpack example to demonstrate how to bundle and use the library with Webpack.
-
Navigate to the example directory:
cd path/to/blockcore-ws/example/webpack -
Ensure your
webpack.config.jsis set up to use ES modules:import path from 'path'; export default { context: path.resolve(), entry: { app: path.join(path.resolve(), './app.js') }, target: 'web', output: { path: path.resolve(), filename: '[name].output.js', } };
-
Install dependencies and build the project:
npm install npm run build
-
Serve the output file using a local server and open it in a browser:
http-server
With these instructions, you should be able to install, run, and use the blockcore-ws library effectively in both Node.js and browser environments. Happy coding! 🎉