@zip.js/zip.js

What is @zip.js/zip.js?

@zip.js/zip.js is a JavaScript library that provides functionalities for creating, reading, and manipulating ZIP files directly in the browser or in Node.js environments. It supports various compression methods and allows for asynchronous operations, making it suitable for handling large files efficiently.

What are @zip.js/zip.js's main functionalities?

Creating ZIP Files

This feature allows you to create a ZIP file and add files to it. In this example, a text file named 'hello.txt' with the content 'Hello, World!' is added to the ZIP file.

const { ZipWriter } = require('@zip.js/zip.js');
const writer = new ZipWriter(new zip.BlobWriter('application/zip'));
await writer.add('hello.txt', new zip.TextReader('Hello, World!'));
const zipBlob = await writer.close();
console.log(zipBlob);

Reading ZIP Files

This feature allows you to read the contents of a ZIP file. In this example, the code reads the 'hello.txt' file from the ZIP and logs its content.

const { ZipReader } = require('@zip.js/zip.js');
const reader = new ZipReader(new zip.BlobReader(zipBlob));
const entries = await reader.getEntries();
for (const entry of entries) {
  if (entry.filename === 'hello.txt') {
    const text = await entry.getData(new zip.TextWriter());
    console.log(text); // 'Hello, World!'
  }
}
await reader.close();

Extracting ZIP Files

This feature allows you to extract files from a ZIP archive. The example demonstrates how to extract each file as a Blob object.

const { ZipReader } = require('@zip.js/zip.js');
const reader = new ZipReader(new zip.BlobReader(zipBlob));
const entries = await reader.getEntries();
for (const entry of entries) {
  const blob = await entry.getData(new zip.BlobWriter());
  console.log(blob); // Blob object for each file
}
await reader.close();

Other packages similar to @zip.js/zip.js

jszip

JSZip is a popular library for creating, reading, and editing .zip files with JavaScript. It is widely used and has a straightforward API. Compared to @zip.js/zip.js, JSZip is more mature and has a larger user base, but it may not support as many advanced features or compression methods.

adm-zip

ADM-ZIP is a pure JavaScript implementation for ZIP file handling in Node.js. It provides functionalities for reading and writing ZIP files, including support for password-protected archives. ADM-ZIP is more focused on Node.js environments, whereas @zip.js/zip.js can be used both in the browser and Node.js.

yazl

Yazl is a ZIP file creation library for Node.js. It is designed to be fast and efficient, with a focus on streaming data into ZIP files. Compared to @zip.js/zip.js, Yazl is more specialized for ZIP file creation and may not offer as many features for reading or manipulating existing ZIP files.

README

zip.js is an open-source library (BSD-3-Clause license) for zipping and unzipping files in the browser.

See here for more info: https://gildas-lormeau.github.io/zip.js/