Class MetadataPackageReader

Implements

PackageReaderInterface

Index

Constructors

Methods

count fileContents getFilename getThirdParties jsonSerialize metadata metadataToArray createFromContents createFromFile

Constructors

constructor

new MetadataPackageReader(
_packageReader: PackageReaderInterface,
_thirdParties?: ThirdPartiesRecords,
): MetadataPackageReader
Parameters
- _packageReader: PackageReaderInterface
- Optional_thirdParties: ThirdPartiesRecords
Returns MetadataPackageReader
- Defined in src/package_reader/metadata_package_reader.ts:9

Methods

count

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

Returns Promise<number>
Implementation of PackageReaderInterface.count
- Defined in src/package_reader/metadata_package_reader.ts:59

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>>
Implementation of PackageReaderInterface.fileContents
- Defined in src/package_reader/metadata_package_reader.ts:68

getFilename

getFilename(): string
Retrieve the currently open file name

Returns string
Implementation of PackageReaderInterface.getFilename
- Defined in src/package_reader/metadata_package_reader.ts:55

getThirdParties

getThirdParties(): Promise<ThirdPartiesRecords>
Returns Promise<ThirdPartiesRecords>
- Defined in src/package_reader/metadata_package_reader.ts:34

jsonSerialize

jsonSerialize(): Promise<
    {
        files: Record<string, string>;
        metadata: Record<string, Record<string, string>>;
        source: string;
    },
>
Returns Promise<
    {
        files: Record<string, string>;
        metadata: Record<string, Record<string, string>>;
        source: string;
    },
>
- Defined in src/package_reader/metadata_package_reader.ts:72

metadata

metadata(): AsyncGenerator<MetadataItem>
Returns AsyncGenerator<MetadataItem>
- Defined in src/package_reader/metadata_package_reader.ts:42

metadataToArray

metadataToArray(): Promise<MetadataItem[]>
Returns Promise<MetadataItem[]>
- Defined in src/package_reader/metadata_package_reader.ts:92

`Static`createFromContents

createFromContents(contents: string): Promise<MetadataPackageReader>
Parameters
- contents: string
Returns Promise<MetadataPackageReader>
- Defined in src/package_reader/metadata_package_reader.ts:23

`Static`createFromFile

createFromFile(fileName: string): Promise<MetadataPackageReader>
Parameters
- fileName: string
Returns Promise<MetadataPackageReader>
- Defined in src/package_reader/metadata_package_reader.ts:14