Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LimitedEventPhaseView

Interface: LimitedEventPhaseView ​

Defined in: packages/ts-sdk/src/generated/types/common.ts:2941

Public event phase.

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

console.log(limitedEventPhaseView)

Properties ​

boosterIndex? ​

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

const { boosterIndex } = limitedEventPhaseView

console.log(boosterIndex)

optional boosterIndex?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:2945

Zero-based booster index for active or next pack phases.


deadlineMs? ​

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

const { deadlineMs } = limitedEventPhaseView

console.log(deadlineMs)

optional deadlineMs?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:2949

Absolute pick deadline in ms since the Unix epoch. Absent when untimed.


durationMs? ​

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

const { durationMs } = limitedEventPhaseView

console.log(durationMs)

optional durationMs?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:2954

Total duration of the current phase in ms, used to render the countdown ring. Absent when untimed.


kind ​

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

const { kind } = limitedEventPhaseView

console.log(kind)

kind: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:2958

Stable phase key such as waiting, leaderDraft, packDraft, review, or complete.


pickNumber? ​

Example:

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

const limitedEventPhaseView: LimitedEventPhaseView = {
  "kind": 'example',
}

const { pickNumber } = limitedEventPhaseView

console.log(pickNumber)

optional pickNumber?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:2962

One-based pick number within the active phase.

Released under the MIT License.