Class CSVCardIndex

Parses and stores intermediate card data from a single CSV file.

Stores the imported card data by Scryfall ID and combines quantity for duplicate entries.

Index

Constructors

Accessors

Methods

add clear delete entries get getVariant has hasVariant keys values fromCSV

Constructors

constructor

new CSVCardIndex(): CSVCardIndex
Returns CSVCardIndex

Accessors

filename

get filename(): string
Returns string
File name associated with this index.

size

get size(): number
Returns number
Number of unique cards by Scryfall ID in index.

Methods

add

add(card: CSVCard): this
Parameters
- card: CSVCard
  CSVCard to add to index.
Returns this
This instance.

clear

clear(): void
Clear all card data stored in this index.

Returns void

delete

delete(key: string): boolean
Parameters
- key: string
  Scryfall ID.
Returns boolean
Was the card deleted.

entries

entries(): IterableIterator<[string, readonly CSVCard[]]>
Returns IterableIterator<[string, readonly CSVCard[]]>
Iterator over entries.

get

get(key: string): readonly CSVCard[]
Parameters
- key: string
  Scryfall ID
Returns readonly CSVCard[]
CSVCard data for all variants.

getVariant

getVariant(
query: { finish?: CardFinish; scryfall_id: string; user_lang?: string },
): CSVCard
Parameters
- query: { finish?: CardFinish; scryfall_id: string; user_lang?: string }
  Specific variant query.
  - Optionalfinish?: CardFinish
    Finish; default: normal.
  - scryfall_id: string
    Scryfall ID
  - Optionaluser_lang?: string
    User defined language code; default: en.
Returns CSVCard

has

has(key: string): boolean
Does this index contain any card w/ matching Scryfall ID?
Parameters
- key: string
  Scryfall ID.
Returns boolean
Does this index contain the card?

hasVariant

hasVariant(
query: { finish?: CardFinish; scryfall_id: string; user_lang?: string },
): boolean
Does this index contain a specific variant by Scryfall ID?
Parameters
- query: { finish?: CardFinish; scryfall_id: string; user_lang?: string }
  Specific variant query.
  - Optionalfinish?: CardFinish
    Finish; default: normal.
  - scryfall_id: string
    Scryfall ID
  - Optionaluser_lang?: string
    User defined language code; default: en.
Returns boolean

keys

keys(): MapIterator<string>
Returns MapIterator<string>
Scryfall ID iterator.

values

values(): IterableIterator<CSVCard>
Returns IterableIterator<CSVCard>
CSVCard iterator.

`Static`fromCSV

fromCSV(options: { filepath: string }): Promise<CSVCardIndex>
Parameters
- options: { filepath: string }
  Options.
  - filepath: string
    CSV filepath to load.
Returns Promise<CSVCardIndex>
Import index of CSV card data.