Class ZipReader<Type>

Represents an instance used to read a zip file.

Example

Here is an example showing how to read the text data of the first entry from a zip file:

// create a BlobReader to read with a ZipReader the zip from a Blob object
const reader = new zip.ZipReader(new zip.BlobReader(blob));

// get all entries from the zip
const entries = await reader.getEntries();
if (entries.length) {

  // get first entry content as text by using a TextWriter
  const text = await entries[0].getData(
    // writer
    new zip.TextWriter(),
    // options
    {
      onprogress: (index, max) => {
        // onprogress callback
      }
    }
  );
  // text contains the entry data as a String
  console.log(text);
}

// close the ZipReader
await reader.close();

Type Parameters

  • Type

Constructors

constructor

Properties

appendedData? comment prependedData?

Methods

close getEntries getEntriesGenerator

Constructors

constructor

Properties

Optional appendedData

appendedData?: Uint8Array

The data appended after the zip file.

comment

comment: Uint8Array

The global comment of the zip file.

Optional prependedData

prependedData?: Uint8Array

The data prepended before the zip file.

Methods

close

  • close(): Promise<void>

  • Closes the zip file

    Returns Promise<void>

getEntries

getEntriesGenerator

  • getEntriesGenerator(options?): AsyncGenerator<Entry, boolean, unknown>

  • Returns a generator used to iterate on all the entries in the zip file

    Parameters

    Returns AsyncGenerator<Entry, boolean, unknown>

    An asynchronous generator of Entry instances.

Settings

Member Visibility

Theme

On This Page

constructorappendedDatacommentprependedDataclosegetEntriesgetEntriesGenerator