Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyListServerMessage

Type Alias: LobbyListServerMessage ​

LobbyListServerMessage = { payload: LobbyListResponse; type: "snapshot"; } | { payload: { nonce?: string | null; }; type: "pong"; }

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:426

Wire messages pushed over the list-level lobby socket (GET /ws/lobbies).

Unlike LobbyServerMessage (the per-lobby socket), this carries the public, viewer-agnostic lobby list. The server sends a snapshot immediately on connect and a fresh snapshot on every list-affecting change; pong replies to a client ping keepalive. Each snapshot is the complete, authoritative list — replace, never merge.

Example:

ts
import type { LobbyListServerMessage } from '@my-swu/simulator-client'

const lobbyListServerMessage: LobbyListServerMessage = {
  "type": "snapshot",
  "payload": {
    "lobbies": [],
  },
}

console.log(lobbyListServerMessage)

Released under the MIT License.