Secure Connect Manager Library Documentation

Overview

Secure Connect Manager is a sophisticated library crafted for managing WebSocket connections and server discovery in JavaScript applications. It excels in seamlessly connecting to servers, maintaining active connections, and dynamically discovering new servers.

Installation

Install the Secure Connect Manager library in your project using npm or yarn:

npm i @intershare/hooks.secure-connect-manager

Or with yarn:

yarn add @intershare/hooks.secure-connect-manager

Initialization

To use Secure Connect Manager, initialize the connection manager with your API endpoint and desired discovery interval:

import { secureConnectManager } from '@intershare/hooks.secure-connect-manager'

secureConnectManager.init({
  api: 'yourApiEndpoint',
  discoveryInterval: 60000,
})

This configures the manager for your API endpoint with a 60-second discovery interval.

Basic Usage

Connecting to WebSocket Servers

Initiate a connection to a WebSocket server:

await secureConnectManager.connectToSocket('serverUrl', 'apiToken')

Server Discovery

Automatically discover and connect to new servers:

secureConnectManager.init({
  api: 'yourApiEndpoint',
  discoveryInterval: 60000,
})

The manager routinely checks for and connects to new servers.

Advanced Features

Custom Configuration

Customize the discovery interval and API endpoint:

secureConnectManager.init({
  api: 'yourNewApiEndpoint',
  discoveryInterval: 30000,
})

Set a new API endpoint and adjust the discovery interval to 30 seconds.

Types

Secure Connect Manager leverages TypeScript for enhanced code management and error handling:

• TSecureConnectManager: Primary manager type.
• TConfig: Configuration type.

Examples

Initializing and Managing Connections

Example React component for initializing and managing WebSocket connections:

import React, { useEffect } from 'react'
import { secureConnectManager } from '@intershare/hooks.secure-connect-manager'

const ConnectionManager: React.FC = () => {
  useEffect(() => {
    secureConnectManager.init({
      api: 'yourApiEndpoint',
      discoveryInterval: 60000,
    })

    // Additional logic for connection handling
  }, [])

  return <div>Connection Manager Initialized</div>
}

export default ConnectionManager

Contributing

Contributions to Secure Connect Manager are welcome! Whether it's code improvements, bug fixes, or new features, your contributions are valued. Here's how to contribute:

GitHub Repository

Our code is on GitHub. Visit our repository to view the code, fork the project, or submit a pull request:

🔗 Secure Connect Manager on GitHub

Submitting Pull Requests

Suggestions or bug fixes? Submit a pull request:

🔗 Submit a Pull Request

Ensure your code meets the project's standards and includes tests for new features.

Reporting Issues

Found a bug or have a feature request? Open an issue on our GitHub page:

🔗 Report an Issue

Provide detailed information for bug reproduction and expected behavior.

npm Package

Secure Connect Manager is available as an npm package for easy installation and updates:

🔗 Secure Connect Manager on npm

Contact

For direct inquiries or specific concerns, contact via email: [email protected]