Interface Reader

interface Reader {
    get filepath(): string;
    get meta(): Readonly<Scrydex>;
    get sourceMeta(): Readonly<ScryfallBulkData>;
    asStream(
        options?: ScryfallDB.Stream.StreamOptions,
    ): AsyncIterable<Record<string, any>>;
}

Index

Accessors

filepath meta sourceMeta

Methods

Accessors

filepath

get filepath(): string
Returns string
The associated filepath.

meta

get meta(): Readonly<Scrydex>
Returns Readonly<Scrydex>
Scrydex metadata.

sourceMeta

get sourceMeta(): Readonly<ScryfallBulkData>
Returns Readonly<ScryfallBulkData>
Scryfall source metadata.

Methods

asStream

asStream(
options?: ScryfallDB.Stream.StreamOptions,
): AsyncIterable<Record<string, any>>
Stream the card data in the DB asynchronously.
Parameters
- Optionaloptions: ScryfallDB.Stream.StreamOptions
  Optional options.
Returns AsyncIterable<Record<string, any>>
Asynchronous iterator over validated card entries.