@my-swu/simulator-client

---

@my-swu/simulator-client / LimitedEventSnapshot

Type Alias: LimitedEventSnapshot

LimitedEventSnapshot = LimitedEventAccessResponse["snapshot"]

Defined in: packages/ts-sdk/src/resources/limited-events.ts:78

Snapshot visible to the current Limited Event requester.

Public event state is always present; viewer-private pack, pool, and pick data are included only when the request carries a valid seat token.

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',
})

// Include seatToken when viewer-private draft state is needed.
const limitedEventSnapshot = await simulatorClient.limitedEvents.get({
  eventId: 'event_123',
  seatToken: 'limited_token_123',
})

console.log(limitedEventSnapshot)

Example

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

const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

const limitedEventSnapshot: LimitedEventSnapshot =
  await simulatorClient.limitedEvents.get('event_123')
console.log(limitedEventSnapshot.phase.kind)

See

https://simulator-sdk.my-swu.com/guide/limited-events