Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / CoveredCard

Type Alias: CoveredCard

CoveredCard = CoveredCardsResponse["cards"][number]

Defined in: packages/ts-sdk/src/resources/card-types.ts:77

Card metadata plus simulator behavior support returned by cards.covered().

This is useful for tools that need to explain which cards currently have dedicated simulator behavior support.

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',
}) const [
coveredCard
] = await
simulatorClient
.
cards
.
covered
()
console
.
log
(
coveredCard
)

Example

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

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

const supportedCards: CoveredCard[] = await simulatorClient.cards.covered()
console.log(supportedCards[0]?.title)

See

https://simulator-sdk.my-swu.com/guide/client-api

Released under the MIT License.