ws-events-handler

WebSocketEventsHandler

The WebSocketEventsHandler class is a comprehensive JavaScript handler for managing WebSocket connections, including automatic reconnection, heartbeat management, event handling, and offline event storage. This class provides robust support for WebSocket applications, ensuring seamless communication even in unstable network environments.

Features

• Automatic Reconnection: Attempts to reconnect with exponential backoff if the connection drops.
• Heartbeat Support: Regularly pings the server to maintain connection, with configurable intervals and timeouts.
• Event Handling: Allows registration of custom event handlers and triggers them on incoming messages.
• Local Event Storage: Caches events when offline and dispatches them once reconnected.
• Debug Mode: Logs detailed information about the WebSocket connection and events for troubleshooting.
• Network Detection: Listens for network status changes to handle online and offline events.

Installation

Install this module via npm:

npm install ws-events-handler

Usage

Basic Initialization

import WebSocketEventsHandler from './WebSocketEventsHandler';

const wsHandler = new WebSocketEventsHandler('ws://your-websocket-url', {
  heartbeat: { 
    interval: 15000, 
    message: 'ping', 
    expectedResponse: 'pong', 
    timeout: 10000 
  },
  connection: { 
    maxRetries: 5, 
    retryDelay: 1000 
  },
  debug: true
});

Configuration Options

• heartbeat (object):

  • interval: Interval between heartbeats in milliseconds.
  • message: Message sent as heartbeat.
  • expectedResponse: Expected response from server.
  • timeout: Time to wait for a response before reconnecting.

• connection (object):

  • maxRetries: Maximum number of reconnection attempts.
  • retryDelay: Delay between reconnection attempts.
  • fallback.localEvents: Enable storing events locally when offline.

• debug (boolean): Enable verbose logging.

Event Handling

Register an event handler for a specific event:

wsHandler.on('eventName', (data) => {
  console.log('Event received:', data);
});

Cyclic event handling

Register an event handler for a specific event in cycles.

  wsEvents.on('eventName', { 
    cycle: { 
      every: 3,
      exclusive: true,
      once: true,
      callback: (data) => {
        console.log(data);
      }
    },
    callback: (data) => {
      console.log("this won't fire as cycle is configured to be exclusive.")
    }
  })

This configuration will fire callback once 3 messages for 'eventName' have arrived.

Configuration options for cycles

• every: Cycle will be executed every N messages.
• exclusive: Cycle will only execute it's internal callback and not the root callback defined in the handler configuration. If false, root callback will be called every time a message arrives to 'eventName'.
• rounds: Cycle will run N times and then it will self-destruct.
• once: Cycle will run only once. (similar to setting rounds = 1)

Unregister an event:

wsHandler.off('eventName');

Sending Events

To send an event with optional payload:

wsHandler.send('eventName', { key: 'value' });

Destroying the WebSocket Connection

To clean up resources and close the WebSocket connection:

wsHandler.destroy('Reason for destruction');

Methods

• on(eventName, config): Registers an event handler.
• off(eventName): Unregisters an event handler.
• send(eventName, payload): Sends an event with an optional payload.
• destroy(reason): Destroys the WebSocket connection and cleans up resources.

License

This project is licensed under the MIT License.