Class LeaderboardWebSocket

WebSocket client for real-time leaderboard updates

WebSocket connections now work through the main API domain with full Cloudflare proxy protection. Both WebSocket and SSE are supported options for real-time updates.

See

LeaderboardSSE - Alternative method using Server-Sent Events

Index

Constructors

constructor

new LeaderboardWebSocket(
    wsUrl: string,
    apiKey: string,
    options?: {
        maxReconnectAttempts?: number;
        reconnectDelay?: number;
        pingInterval?: number;
    },
): LeaderboardWebSocket
Parameters
- wsUrl: string
- apiKey: string
- options: {
      maxReconnectAttempts?: number;
      reconnectDelay?: number;
      pingInterval?: number;
  } = {}
Returns LeaderboardWebSocket
- Defined in src/websocket.ts:34

Accessors

isConnected

get isConnected(): boolean
Get connection state

Returns boolean
- Defined in src/websocket.ts:151

subscriptions

get subscriptions(): string[]
Get subscribed leaderboards

Returns string[]
- Defined in src/websocket.ts:158

permanentConnectionError

get permanentConnectionError(): null | GlobalLeaderboardsError
Get permanent error if connection was terminated due to a permanent error

Returns null | GlobalLeaderboardsError
- Defined in src/websocket.ts:165

Methods

connect

connect(leaderboardId?: string, userId?: string): void
Connect to the WebSocket server
Parameters
- OptionalleaderboardId: string
- OptionaluserId: string
Returns void
- Defined in src/websocket.ts:61

disconnect

disconnect(): void
Disconnect from the WebSocket server

Returns void
- Defined in src/websocket.ts:98

subscribe(leaderboardId: string, userId?: string): void
Subscribe to a leaderboard
Parameters
- leaderboardId: string
- OptionaluserId: string
Returns void
- Defined in src/websocket.ts:106

unsubscribe

unsubscribe(leaderboardId: string): void
Unsubscribe from a leaderboard
Parameters
- leaderboardId: string
Returns void
- Defined in src/websocket.ts:127

on

on(handlers: Partial<WebSocketHandlers>): void
Set event handlers
Parameters
- handlers: Partial<WebSocketHandlers>
Returns void
- Defined in src/websocket.ts:144

reconnect

reconnect(): void
Manually trigger a reconnection attempt Useful for application-level retry logic

Returns void
- Defined in src/websocket.ts:484

Class LeaderboardWebSocket

See

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns LeaderboardWebSocket

Accessors

isConnected

Returns boolean

subscriptions

Returns string[]

permanentConnectionError

Returns null | GlobalLeaderboardsError

Methods

connect

Parameters

Returns void

disconnect

Returns void

Parameters

Returns void

unsubscribe

Parameters

Returns void

on

Parameters

Returns void

reconnect

Returns void

Settings

On This Page