@my-swu/simulator-client

---

@my-swu/simulator-client / ConnectionState

Type Alias: ConnectionState

ConnectionState = "idle" | "connecting" | "open" | "closed"

Defined in: packages/ts-sdk/src/session.ts:20

Transport lifecycle state for one simulator socket session.

idle means no socket has been opened yet, connecting means handshake is in progress, open means messages can flow, and closed means no active socket is attached.

Example:

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

const connectionState: ConnectionState = 'open'

console.log(connectionState)

Example

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

const currentConnectionState: ConnectionState = 'idle'
console.log(currentConnectionState)

See

https://simulator-sdk.my-swu.com/guide/match-session