socket

Framework: react

WebSocketService Documentation

📥 Importing the Service

import { WebSocketService } from "universe-code/socket";

Initialize once (e.g., in App.tsx)

📁 app.tsx

tsx

useEffect(() => {
  WebSocketService.instance.init({
    baseUrl: "https://example.com",
    path: "/ws",
    transports: ["websocket"],
    autoConnect: true,
    reconnection: true,
    reconnectionAttempts: 5,
    reconnectionDelay: 1000,
    auth: {
      token: "USER_AUTH_TOKEN",
    },
  });
  return () => WebSocketService.instance.disconnect();
}, []);

Note:

if autoConnect is false then connect manually through this function

WebSocketService.instance.connect();

🔑 Update Token (login / logout)

WebSocketService.instance.setToken(/*your token*/);

📩 Subscribe to market

WebSocketService.instance.subscribeMarket(/*Your market id array here*/); //e.g [1,2,3,4,5]

🗑️ Unsubscribe

WebSocketService.instance.unsubscribeMarket(/*Your market id array here*/); //e.g [1,2,3,4,5]

👂 Listen to event in React component

tsx

//onEvent( your event name, callback function )
useEffect(() => {
  const off = WebSocketService.instance.onEvent("marketUpdate", (data) => {
    console.log("Market data =>", data);
  });

  return () => off();
}, []);

📤 Emit custom event

// sendMessage( your evenrt name, your message)
WebSocketService.instance.sendMessage("customEvent", { hello: "world" });

❌ Dissconnect Socket

WebSocketService.instance.disconnect();

📦 Config Object (Required Fields)

Key	Type	Description
`baseUrl`	string	Base Socket.IO server URL
`path`	string	Custom socket path (e.g., `/ws` or `/socket.io`)
`transports`	string[]	Allowed transports (usually `["websocket"]`)
`autoConnect`	boolean	Whether to connect automatically after creation
`reconnection`	boolean	Enable automatic reconnection
`reconnectionAttempts`	number	How many times to retry connection
`reconnectionDelay`	number	Delay between retries (ms)
`auth.token`	string	Bearer token sent as Authorization header

⚠️ Validation

All fields above are required.
If any field is missing, init(config) will throw: