@zip.js/zip.js
    Preparing search index...

    Class ZipReader<Type>

    Represents an instance used to read a zip file.

    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
    Index

    Constructors

    constructor

    Properties

    appendedData? comment prependedData?

    Methods

    close getEntries getEntriesGenerator

    Constructors

    Properties

    appendedData?: Uint8Array<ArrayBuffer>

    The data appended after the zip file.

    comment: Uint8Array<ArrayBuffer>

    The global comment of the zip file.

    prependedData?: Uint8Array<ArrayBuffer>

    The data prepended before the zip file.

    Methods

    • Closes the zip file

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods