@scryfall/api-types v1.0.0-alpha.4

Scryfall API types

This library documents the definitive comprehensive typings of the Scryfall API for use in Typescript & Javascript projects.

This library uses semver for versioning. These versions only describe this library, not the Scryfall API as a whole.

Installation

npm install @scryfall/api-types

Examples

Fetching a card

// CommonJS module syntax
const { ScryfallCard } = require("@scryfall/api-types");

// ES module syntax
import { ScryfallCard } from "@scryfall/api-types";

// Fetch a card
const response = await fetch("https://api.scryfall.com/cards/iko/275");
const godzilla: ScryfallCard.Any = await response.json();

Fetching the list of sets

// CommonJS module syntax
const { ScryfallList } = require("@scryfall/api-types");

// ES module syntax
import { ScryfallList } from "@scryfall/api-types";

// Fetch the list of all setss
const response = await fetch("https://api.scryfall.com/sets");
const sets: ScryfallList.Sets = await response.json();

Type narrowing on a card

import { ScryfallCard, ScryfallLayout } from "@scryfall/api-types";

// This card might be of any type.
// You cannot access `mysteryCard.card_faces`, because it might not have that property.
const mysteryCard: ScryfallCard.Any = getCard();

// You can narrow by layout:
if (mysteryCard.layout === ScryfallLayout.Transform) {
  // It's a transforming DFC!
  // You can access transform-specific fields in this scope, or assign it to a variable.
  const faces = anyCard.card_faces;
  const transform: ScryfallCard.Transform = mysteryCard;
}

// You can also narrow by property:
if ("card_faces" in anyCard) {
  // It's *some* kind of multi-faced card.
  // You can now access the card_faces property.
  // You'll need to do some further type narrowing to know more about what's in the card.
  const faces = anyCard.card_faces;
  const multifaced: ScryfallCard.AnyMultiFaced = anyCard;
} else {
  const sfc: ScryfallCard.AnySingleFaced = anyCard;
}

Usage

Each type and enum exported by this library corresponds to a Scryfall API object and its values.

Points of interest:

• ScryfallCard describes Cards and their faces. Each individual card layout is managed via type narrowing on the layout field.
• ScryfallCatalog describes the catalogs.
• ScryfallError describes error responses.
• ScryfallList describes lists, and provides shortcuts to describe the common types of lists.
• ScryfallMigration describes migrations.
• ScryfallSet describes card sets.

If the API provides an object, this library provides it as well. (If it doesn't, please tell us!)

All primary types and values are prefixed with Scryfall to avoid conflict with the standard library (e.g. Object, Error, Set) and to minimise conflict with your other libraries and dependencies (e.g. Color, LanguageCode). If we didn't have the prefix you'd be forced to append one yourself one on import, so we've defaulted to including it.

Enum fields are described both in terms of an enum and a set of strings in order to give you the option of interacting with that field with either one.