Skip to content

onedionys/onedionys-websocket-wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to One Dionys - WebSocket Wrapper! 👋

Abstraction to communicate over WebSocket with easier syntax. 💖

💾 Requirements

  • Web Browser - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
  • Internet - Because many use CDN and to make it easier to find solutions to all problems.

🎯 How To Use

Example Syntax

const WebSocketWrapper = require('websocket-wrapper');

// Create a new WebSocket instance
const socket = new WebSocketWrapper('ws://localhost:8080');

// Add event listeners
socket.on('open', () => {
    console.log('Connection established.');
});

socket.on('message', (data) => {
    console.log('Received message:', data);
});

socket.on('error', (error) => {
    console.error('WebSocket error:', error);
});

// Send data
socket.send('Hello, server!');

Explanation

  • The WebSocket Wrapper package returns an instance of the WebSocketWrapper class, which encapsulates a WebSocket connection. This instance can be used to interact with the WebSocket connection, such as sending and receiving messages, and listening for connection events like 'open', 'message', and 'error'.

Return Value

  • Directly returns a string value according to the format used. Like Satu Juta or One Million.

📆 Release Date

  • v1.0.0 : 08 March 2024
  • v1.0.1 : 11 March 2024
  • v4.0.0 : 11 March 2024
  • v4.0.1 : 12 March 2024
  • v4.0.2 : 18 March 2024
  • v5.0.0 : 31 March 2024

🧑 Author

📝 License

  • Copyright © 2024 One Dionys
  • One Dionys - WebSocket Wrapper is an open source project licensed under the MIT license

☕️ Suppport & Donation

Love One Dionys - WebSocket Wrapper? Support this project by donating or sharing with others in need.

Made with ❤️ One Dionys