@my-swu/simulator-client

---

@my-swu/simulator-client / LobbyListSessionState

Interface: LobbyListSessionState

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

Aggregated state of a LobbyListSession.

Example:

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

// `lobbyListSession.on('change', ...)` delivers one of these on every update.

export function inspectLobbyListSessionState(lobbyListSessionState: LobbyListSessionState) {
  console.log(lobbyListSessionState)
}

Properties

connectionState

Example:

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

// `lobbyListSession.on('change', ...)` delivers one of these on every update.

export function inspectLobbyListSessionState(lobbyListSessionState: LobbyListSessionState) {
  const { connectionState } = lobbyListSessionState

  console.log(connectionState)
}

connectionState: ConnectionState

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

---

errors

Example:

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

// `lobbyListSession.on('change', ...)` delivers one of these on every update.

export function inspectLobbyListSessionState(lobbyListSessionState: LobbyListSessionState) {
  const { errors } = lobbyListSessionState

  console.log(errors)
}

errors: readonly ErrorPayload[]

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

---

lobbies

Example:

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

// `lobbyListSession.on('change', ...)` delivers one of these on every update.

export function inspectLobbyListSessionState(lobbyListSessionState: LobbyListSessionState) {
  const { lobbies } = lobbyListSessionState

  console.log(lobbies)
}

lobbies: PublicLobbySummary[] | undefined

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

Latest public lobby list, or undefined before the first snapshot.