Function websocket

  • websocket(payload): WebSocket

  • Creates a WebSocket instance with the specified IP and API token.

    Parameters

    • payload: {
          apiEndpoint: string | URL;
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • Optional timeout?: number

        optional timeout for the requests

    Returns WebSocket

    A WebSocket instance.

Settings

Member Visibility

Theme