Class ScryfallDB`Abstract`

Provides a reusable / generic streamable interface over the Scryfall card DB.

Index

Methods

isValidSourceType load loadAll

Methods

`Static`isValidSourceType

isValidSourceType(type: unknown): type is ScryfallDB.File.DBType
Type guard for ScryfallDB.File.DBType.
Parameters
- type: unknown
Returns type is ScryfallDB.File.DBType

`Static`load

load(options: { filepath: string }): Promise<ScryfallDB.Stream.Reader>
Attempts to load a Scrydex JSON card DB from the given file path.
Parameters
- options: { filepath: string }
  Options.
  - filepath: string
    Filepath to load.
Returns Promise<ScryfallDB.Stream.Reader>
ScryfallDB.Stream.Reader instance.

Throws
Error

`Static`loadAll

loadAll(
    options: {
        dirpath: string;
        type?: ScryfallDB.File.DBType | Iterable<ScryfallDB.File.DBType, any, any>;
        walk?: boolean;
    },
): Promise<ScryfallDB.Stream.Reader[]>
Load all ScryfallDBs in the specified directory path. Additional options allow filtering by DB type.
Parameters
- options: {
      dirpath: string;
      type?: ScryfallDB.File.DBType | Iterable<ScryfallDB.File.DBType, any, any>;
      walk?: boolean;
  }
  Options.
  - dirpath: string
    Directory path to load.
  - Optionaltype?: ScryfallDB.File.DBType | Iterable<ScryfallDB.File.DBType, any, any>
    Match type of CardDB.
  - Optionalwalk?: boolean
    Walk all subdirectories for CardDB files to load; default: false
Returns Promise<ScryfallDB.Stream.Reader[]>
Configured CardDB.Stream.Reader instances for the found JSON card DB collections.