Type Alias PackageReaderInterface

Expected behavior of a PackageReader contract

type PackageReaderInterface = {
    count(): Promise<number>;
    fileContents(): AsyncGenerator<Map<string, string>>;
    getFilename(): string;
}

Implemented by

Index

Methods

count fileContents getFilename

Methods

count

count(): Promise<number>
Return the number of elements on the package

Returns Promise<number>
- Defined in src/package_reader/package_reader_interface.ts:12

fileContents

fileContents(): AsyncGenerator<Map<string, string>>
Traverse each file inside the package, with the filename as key and file content as value

Returns AsyncGenerator<Map<string, string>>
- Defined in src/package_reader/package_reader_interface.ts:8

getFilename

getFilename(): string
Retrieve the currently open file name

Returns string
- Defined in src/package_reader/package_reader_interface.ts:16