@my-swu/simulator-client

---

@my-swu/simulator-client / TournamentRoomSession

Interface: TournamentRoomSession

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:80

Live tournament room websocket controller.

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

console.log(tournamentRoomSession)

Properties

connectionState

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { connectionState } = tournamentRoomSession

console.log(connectionState)

readonly connectionState: ConnectionState

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:81

---

errorMessages

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { errorMessages } = tournamentRoomSession

console.log(errorMessages)

readonly errorMessages: readonly string[]

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:82

---

errors

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { errors } = tournamentRoomSession

console.log(errors)

readonly errors: readonly ErrorPayload[]

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:83

---

snapshot

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { snapshot: matchSnapshot } = tournamentRoomSession

console.log(matchSnapshot)

readonly snapshot: TournamentRoomSnapshot | undefined

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:84

Methods

close()

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { close } = tournamentRoomSession

console.log(close)

close(): void

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:86

Returns

void

---

connect()

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { connect } = tournamentRoomSession

console.log(connect)

connect(): Promise<TournamentRoomSession>

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:85

Returns

Promise<TournamentRoomSession>

---

on()

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { on } = tournamentRoomSession

console.log(on)

on<TKey>(event, listener): () => void

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:87

Type Parameters

TKey

TKey extends keyof TournamentRoomSessionEvents

Parameters

event

TKey

listener

(value) => void

Returns

() => void

---

ping()

Example:

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

// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

// Keep playerToken private; it authenticates this room player.
const tournamentRoomSession = simulatorClient.tournamentRooms.createSession({
  roomId: 'room_123',
  playerToken: 'player_token_123',
})

const { ping } = tournamentRoomSession

console.log(ping)

ping(nonce?): void

Defined in: packages/ts-sdk/src/resources/tournament-room-types.ts:91

Parameters

nonce?

string

Returns

void