Class CSVCollection

Common interface for all imported collection data.

Implements

ImportCollection

Index

Constructors

Accessors

Methods

clear delete entries get getCardGroups has hasVariant isCardGroup keys values load

Constructors

constructor

new CSVCollection(): CSVCollection
Returns CSVCollection

Accessors

groups

get groups(): MetadataGroups
Returns MetadataGroups
The groups CSV file name metadata.

size

get size(): number
Returns number
Total count of all unique cards in the collection

Methods

clear

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

Returns void

delete

delete(key: string): void
Deletes card from all collection indexes.
Parameters
- key: string
  Scryfall ID.
Returns void

entries

entries(): IterableIterator<[string, readonly CSVCard[]]>
Returns IterableIterator<[string, readonly CSVCard[]]>
Entries iterator.

get

get(key: string): CSVCard[]
Get all CSV card entries across all CSV indexed files for the given Scryfall ID.
Parameters
- key: string
  Scryfall ID.
Returns CSVCard[]
An array of all CSV card entries matching the given key.

getCardGroups

getCardGroups(card: CSVCard): Set<keyof MetadataGroups<string[]>>
Returns the group name(s) this card belongs to if any..
Parameters
- card: CSVCard
Returns Set<keyof MetadataGroups<string[]>>

has

has(key: string): boolean
Parameters
- key: string
  Scryfall ID.
Returns boolean
Does any collection index have the given card.

Implementation of ImportCollection.has

hasVariant

hasVariant(
query: { finish?: CardFinish; scryfall_id: string; user_lang?: string },
): boolean
Does this collection 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

isCardGroup

isCardGroup(card: CSVCard, group: keyof MetadataGroups<string[]>): boolean
Checks the meta external file names for a card file name match.
Parameters
- card: CSVCard
- group: keyof MetadataGroups<string[]>
  External card group to test for inclusion.
Returns boolean

keys

keys(): IterableIterator<string>
Returns IterableIterator<string>
Iterator for all unique Scryfall IDs contained in this collection.

values

values(): IterableIterator<CSVCard>
Returns IterableIterator<CSVCard>
Iterator for all CSV card entries stored in this collection. May contain duplicate cards from separate CSV index files.

`Static`load

load(
    options: {
        groups?: MetadataGroups<string>;
        logger?: BasicLogger;
        path: string;
    },
): Promise<CSVCollection>
Load collection.
Parameters
- options: { groups?: MetadataGroups<string>; logger?: BasicLogger; path: string }
  Options.
  - Optionalgroups?: MetadataGroups<string>
    Input CSV file or directory path to CSV files for card collections representing various groups.
  - Optionallogger?: BasicLogger
    Optional logger instance.
  - path: string
    A single CSV file path or a directory path to load all .csv files.
Returns Promise<CSVCollection>
A new collection of all CSV card data.