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

    Class ZipWriter<Type>

    Represents an instance used to create a zip file.

    Here is an example showing how to create a zip file containing a compressed text file:

    // use a BlobWriter to store with a ZipWriter the zip into a Blob object
    const blobWriter = new zip.BlobWriter("application/zip");
    const writer = new zip.ZipWriter(blobWriter);

    // use a TextReader to read the String to add
    await writer.add("filename.txt", new zip.TextReader("test!"));

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

    // get the zip file as a Blob
    const blob = await blobWriter.getData();

    Type Parameters

    • Type
    Index

    Constructors

    Properties

    hasCorruptedEntries?: boolean

    true if the zip contains at least one entry that has been partially written.

    Methods

    • Writes the entries directory, writes the global comment, and returns the content of the zip file

      Parameters

      • Optionalcomment: Uint8Array<ArrayBufferLike>

        The global comment of the zip file.

      • Optionaloptions: ZipWriterCloseOptions

        The options.

      Returns Promise<Type>

      The content of the zip file.

    • Adds an existing zip file at the beginning of the current zip. This method cannot be called after the first call to ZipWriter#add.

      Type Parameters

      • ReaderType

      Parameters

      Returns Promise<void>

      A promise resolving when the zip file has been added.

    • Removes an entry from the zip file. Note that the entry is not removed from the zip file, but it is not written to the entries directory.

      Parameters

      • entry: string | Entry

        The entry to remove. This can be an Entry instance or the filename of the entry.

      Returns boolean

      true if the entry has been removed, false otherwise.