Description

Socket-package is a lightweight and efficient utility designed for establishing and handling socket connections with ease. Built on top of the popular socket.io-client, this package simplifies the process of initializing socket instances, handling incoming messages, and managing sessions. Whether you're building a chat application, real-time data dashboard, or any other system that relies on websockets, socket-package is here to make your development process smoother.

Installation

npm install socket-package

Usage

Initialization

import { UCI } from 'socket-package';

const url = 'YOUR_SOCKET_URL';
// Socket Options con have key-value pairs such as 
// reconnection: true, reconnectionDelay: 1000, timeout: 10000, etc.
const socketOptions = {};
const onReceiveMessage = (message) => {
   console.log("Received message: ", message);
};

const socket = new UCI(url, socketOptions, callback);

Sending Messages

socket.sendMessage({
   text: 'Your Message Text',
   to: 'Recipient',
   from: 'Sender',
   optional: {
      appId: 'YourAppID',
      channel: 'YourChannel'
   }
});

Handling Disconnects

socket.onDisconnect(() => {
   console.log("Socket disconnected");
});

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this package in your projects, as long as the original license and copyright notes are included.

Issues and Contributions

Your feedback is crucial to the improvement of socket-package. If you encounter any issues or have suggestions for improvements, please feel free to reach out to us, We also welcome contributions to the project here.

Reporting Issues: Please use the GitHub issues page to report any issues you encounter. Contributions: We welcome contributions! Please feel free to fork the repository, make your changes, and submit a pull request. Thank you for your support!