@globalleaderboards/sdk - v0.5.0
    Preparing search index...

    Class LeaderboardSSE

    LeaderboardSSE client for Server-Sent Events

    const sse = new LeaderboardSSE(config)

    const connection = sse.connect('leaderboard-id', {
    onLeaderboardUpdate: (data) => {
    console.log('Leaderboard updated:', data.topScores)
    },
    onUserRankUpdate: (data) => {
    console.log('User rank changed:', data)
    }
    })

    // Later...
    connection.close()
    Index

    Constructors

    Methods

    • Connect to a leaderboard's SSE stream

      Parameters

      Returns { close: () => void }

      Connection object with close method

    • Disconnect from a specific leaderboard

      Parameters

      • leaderboardId: string

        The leaderboard to disconnect from

      Returns void

    • Disconnect from all leaderboards

      Returns void

    • Check if connected to a specific leaderboard

      Parameters

      • leaderboardId: string

        The leaderboard to check

      Returns boolean

      Whether connected to the leaderboard

    • Get connection status for all leaderboards

      Returns Map<string, "open" | "connecting" | "closed">

      Map of leaderboard IDs to connection states