Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LimitedEventAccess

Type Alias: LimitedEventAccess ​

LimitedEventAccess = LimitedEventAccessResponse

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

Access token and private snapshot returned after creating or joining a Limited Event.

Keep seatToken private. It authorizes one player seat inside the event pod.

Example:

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

// Access carries event id plus this viewer's private seat token.
const limitedEventAccess = await simulatorClient.limitedEvents.create({
  kind: 'draft',
  draftRounds: [],
  pickTimerEnabled: false,
  setCode: 'SOR',
  playerCount: 4,
})

console.log(limitedEventAccess)

Example ​

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

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

const draftEventAccess: LimitedEventAccess =
  await simulatorClient.limitedEvents.create({
    kind: 'draft',
    draftRounds: [],
    pickTimerEnabled: false,
    setCode: 'SOR',
    playerCount: 4,
  })
console.log(draftEventAccess.eventId)

See ​

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

Released under the MIT License.