Interface StateStore<TSettings, TOverlayExtensions>

ReadonlyisSynchronized

get

• get(): MatchState<TSettings, TOverlayExtensions> | null

  Current hydrated state, or null until the first snapshot after connecting.

  Returns MatchState<TSettings, TOverlayExtensions> | null

player

• player(playerId: string | number): Player | null

  Parameters

  • playerId: string | number

  Returns Player | null

subscribe

• subscribe(
      listener: (
          state: MatchState<TSettings, TOverlayExtensions> | null,
      ) => void | Promise<void>,
      options?: SubscriptionOptions,
  ): () => void

  Runs immediately and after every later state update, reset, or synchronization-freshness change. The same state identity may be delivered when only freshness changes. Null means no hydrated state is currently available.

  Parameters

  • listener: (
        state: MatchState<TSettings, TOverlayExtensions> | null,
    ) => void | Promise<void>
  • Optionaloptions: SubscriptionOptions

  Returns () => void

watch

• watch<T>(
      selector: (state: MatchState<TSettings, TOverlayExtensions> | null) => T,
      listener: (
          value: T,
          previousValue: T | undefined,
          state: MatchState<TSettings, TOverlayExtensions> | null,
      ) => void | Promise<void>,
      options?: WatchOptions<T>,
  ): () => void

  Runs immediately for the first selected value, including unavailable state, and reevaluates after state, reset, or synchronization-freshness changes. The listener runs according to the configured equality function.

  Type Parameters

  • T

  Parameters

  • selector: (state: MatchState<TSettings, TOverlayExtensions> | null) => T
  • listener: (
        value: T,
        previousValue: T | undefined,
        state: MatchState<TSettings, TOverlayExtensions> | null,
    ) => void | Promise<void>
  • Optionaloptions: WatchOptions<T>

  Returns () => void

whenReady

• whenReady(
      options?: ReadyOptions,
  ): Promise<MatchState<TSettings, TOverlayExtensions>>

  Wait for the first state snapshot. The default timeout is 10 seconds; zero disables the timeout.

  Parameters

  • Optionaloptions: ReadyOptions

  Returns Promise<MatchState<TSettings, TOverlayExtensions>>

whenSynchronized

• whenSynchronized(
      options?: ReadyOptions,
  ): Promise<MatchState<TSettings, TOverlayExtensions>>

  Wait for a complete snapshot belonging to the current transport generation.

  Parameters

  • Optionaloptions: ReadyOptions

  Returns Promise<MatchState<TSettings, TOverlayExtensions>>