@my-swu/simulator-client

---

@my-swu/simulator-client / LimitedEventSessionState

Interface: LimitedEventSessionState

Defined in: packages/ts-sdk/src/resources/limited-event-types.ts:160

Aggregated direct Limited Event socket state.

Example:

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

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

export function inspectLimitedEventSessionState(limitedEventSessionState: LimitedEventSessionState) {
  console.log(limitedEventSessionState)
}

Properties

connectionState

Example:

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

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

export function inspectLimitedEventSessionState(limitedEventSessionState: LimitedEventSessionState) {
  const { connectionState } = limitedEventSessionState

  console.log(connectionState)
}

connectionState: ConnectionState

Defined in: packages/ts-sdk/src/resources/limited-event-types.ts:161

---

errors

Example:

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

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

export function inspectLimitedEventSessionState(limitedEventSessionState: LimitedEventSessionState) {
  const { errors } = limitedEventSessionState

  console.log(errors)
}

errors: readonly ErrorPayload[]

Defined in: packages/ts-sdk/src/resources/limited-event-types.ts:162

---

snapshot

Example:

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

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

export function inspectLimitedEventSessionState(limitedEventSessionState: LimitedEventSessionState) {
  const { snapshot: limitedEventSnapshot } = limitedEventSessionState

  console.log(limitedEventSnapshot)
}

snapshot: LimitedEventSnapshot | undefined

Defined in: packages/ts-sdk/src/resources/limited-event-types.ts:163