Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / SimulatorAvailabilityResponse

Interface: SimulatorAvailabilityResponse ​

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

Public simulator availability payload.

Example:

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

const simulatorAvailabilityResponse: SimulatorAvailabilityResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "checkedAtMs": 0,
}

console.log(simulatorAvailabilityResponse)

Properties ​

acceptingNewMatches ​

Example:

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

const simulatorAvailabilityResponse: SimulatorAvailabilityResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "checkedAtMs": 0,
}

const { acceptingNewMatches } = simulatorAvailabilityResponse

console.log(acceptingNewMatches)

acceptingNewMatches: boolean

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

Whether the engine is accepting new matches/sessions.


checkedAtMs ​

Example:

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

const simulatorAvailabilityResponse: SimulatorAvailabilityResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "checkedAtMs": 0,
}

const { checkedAtMs } = simulatorAvailabilityResponse

console.log(checkedAtMs)

checkedAtMs: number

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

Epoch milliseconds when this status was generated.


maintenance ​

Example:

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

const simulatorAvailabilityResponse: SimulatorAvailabilityResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "checkedAtMs": 0,
}

const { maintenance } = simulatorAvailabilityResponse

console.log(maintenance)

maintenance: MaintenanceStatus

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

Current drain-mode state.

Released under the MIT License.