WebSocket Client Documentation

Overview

This project implements a WebSocket client for connecting to and interacting with WebSocket servers. It is built using Node.js and incorporates various utility functions for improved functionality and ease of use.

Features

• Connect to WebSocket servers: Supports both ws:// and wss:// protocols.
• Dynamic request handling: Utilize templates and variable replacements for dynamic URLs, headers, and messages.
• Error and event handling: Robust handling of connection failures, message reception, and disconnections.
• Proxy support: Integrated support for HTTP and HTTPS proxies.
• Customizable options: Configurable timeouts, headers, and authentication mechanisms.

Installation

To use this WebSocket client, ensure you have Node.js installed, then install the necessary dependencies:

npm install websocket-client-pro

Usage

Importing the Client

const { WSClient } = require("./path/to/your/client");

Example

Here's a simple example of how to connect to a WebSocket server, send a message, and close the connection:

const chunk = {
  option: { /* your options */ },
  target: { /* your target */ },
};

(async () => {
  const callback = (msg) => {
    console.log(JSON.stringify(msg, null, "\t"));
  };

  try {
    const ws = new WSClient(chunk.target, chunk.option, callback);
    const response = await ws.connect();
    console.log(response);

    setTimeout(() => {
      ws.send("Your message here");
    }, 2000);

    setTimeout(() => {
      ws.close();
    }, 4000);

    let msg = await ws.wait();
    console.log(msg);
  } catch (e) {
    if (e?.stack) {
      console.log(e.stack);
    }
    console.error(e);
  }
})();

Methods

1. connect()

   • Connects to the WebSocket server.
   • Returns a Promise that resolves on successful connection.

2. send(data)

   • Sends data to the connected WebSocket server.
   • Accepts an object containing the message and its type.

3. close()

   • Closes the WebSocket connection gracefully.

4. wait()

   • Returns a Promise that resolves when the connection closes or is not established.

Configuration Options

The client can be configured dynamically using the option object, which supports global variables, environment variables, and proxy configurations.

Example Configuration

const options = {
  globals: { /* global variables */ },
  env: {
    env_id: "1",
    env_name: "Default Environment",
    environment: { /* environmental variables */ },
  },
  system_configs: {
    send_timeout: 0,
    proxy: {
      type: 1,
      auth: { /* proxy authentication details */ }
    },
  },
};

Testing

To run tests, you can use the following command:

npm test

Contribution

Feel free to fork the repository and submit pull requests. Ensure to follow the coding standards and add relevant tests for any new features.

License

This project is licensed under the MIT License. See the LICENSE file for details.

For more detailed instructions or issues, please check the project's GitHub repository or contact the maintainer.