Skip to content

Deck

The Deck Data Model describes the properties of an individual Deck.

TypeScript Model

Toggle Model
TypeScript
export type Deck = {
  code: string;
  commander?: CardDeck;
  fileName: string;
  mainBoard: CardDeck[];
  name: string;
  releaseDate: string | null;
  sideBoard: CardDeck[];
  type: string;
};

Model Properties

code

The printing set code for the deck.

  • Type: string
  • Introduced: v4.3.0

commander O

The card that is the Commander in this deck. See the Card (Deck) Data Model.

  • Type: CardDeck
  • Introduced: v5.1.0

fileName

The file name for the deck. Combines the name and code properties to avoid namespace collisions and are given a _ delimiter.

  • Type: string
  • Example: "SpiritSquadron_VOC"
  • Introduced: v4.3.0

mainBoard

The cards in the main-board. See the Card (Deck) Data Model.

  • Type: CardDeck[]
  • Introduced: v4.3.0

name

The name of the deck.

  • Type: string
  • Introduced: v4.3.0

releaseDate

The release date in ISO 8601 format for the set. Returns null if the deck was not formally released as a product.

  • Type: string | null
  • Introduced: v4.3.0

sideBoard

The cards in the side-board. See the Card (Deck) Data Model.

  • Type: CardDeck[]
  • Introduced: v4.3.0

type

The type of deck.

  • Type: string
  • Introduced: v4.3.0