Class FilteredPackageReader

Implements

PackageReaderInterface

Index

Constructors

Methods

changeFilter count destruct fileContents getArchive getFilename getFilter jsonSerialize setFilter createFromContents createFromFile

Constructors

constructor

new FilteredPackageReader(
filename: string,
archive: JSZip,
): FilteredPackageReader
Parameters
- filename: string
- archive: JSZip
Returns FilteredPackageReader
- Defined in src/package_reader/internal/filtered_package_reader.ts:21

Methods

changeFilter

changeFilter(filter: FileFilterInterface): FileFilterInterface
Parameters
- filter: FileFilterInterface
Returns FileFilterInterface
- Defined in src/package_reader/internal/filtered_package_reader.ts:134

count

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

Returns Promise<number>
Implementation of PackageReaderInterface.count
- Defined in src/package_reader/internal/filtered_package_reader.ts:109

destruct

destruct(): Promise<void>
Returns Promise<void>
- Defined in src/package_reader/internal/filtered_package_reader.ts:83

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/internal/filtered_package_reader.ts:89

getArchive

getArchive(): JSZip
Returns JSZip
- Defined in src/package_reader/internal/filtered_package_reader.ts:122

getFilename

getFilename(): string
Retrieve the currently open file name

Returns string
Implementation of PackageReaderInterface.getFilename
- Defined in src/package_reader/internal/filtered_package_reader.ts:118

getFilter

getFilter(): FileFilterInterface
Returns FileFilterInterface
- Defined in src/package_reader/internal/filtered_package_reader.ts:126

jsonSerialize

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

setFilter

setFilter(filter?: FileFilterInterface): void
Parameters
- Optionalfilter: FileFilterInterface
Returns void
- Defined in src/package_reader/internal/filtered_package_reader.ts:130

`Static`createFromContents

createFromContents(contents: string): Promise<FilteredPackageReader>
Parameters
- contents: string
Returns Promise<FilteredPackageReader>
- Defined in src/package_reader/internal/filtered_package_reader.ts:46

`Static`createFromFile

createFromFile(filename: string): Promise<FilteredPackageReader>
Parameters
- filename: string
Returns Promise<FilteredPackageReader>
- Defined in src/package_reader/internal/filtered_package_reader.ts:26