unzipper 0.8.14

Unzipper, an active fork of "node-unzip", is a powerful tool packed with new features not present in the original. It offers cross-platform streaming APIs for parsing and extracting zip files. The software picks up where "node-unzip" left off, using Promises and the inherent guarantees provided by node streams to assure low memory footprint and consistent functionality of finish/close events at the end of processing.

To use unzipper, first install the package with the command npm install unzipper. Once the installation process is completed, unleash the power of unzipper by importing it into your project via the require function. Use fs.createReadStream('path/to/archive.zip').pipe(unzipper.Extract({ path: 'output/path' })); to extract zip files to a particular directory. To process zip file entries or to pipe entries to another stream, use unzipper.Parse().

Here is a detailed example:

const unzipper = require('unzipper');
const fs = require('fs');
fs.createReadStream('path/to/archive.zip')
  .pipe(unzipper.Parse())
  .on('entry', function (entry) {
    const fileName = entry.path;
    const type = entry.type; // 'Directory' or 'File'
    const size = entry.vars.uncompressedSize; // There is also compressedSize;
    if (fileName === "this IS the file I'm looking for") {
      entry.pipe(fs.createWriteStream('output/path'));
    } else {
      entry.autodrain();
    }
 });

The documentation for the Unzipper is primarily found in its README content of the package's GitHub page at "https://github.com/ZJONSSON/node-unzipper". The README file gives an exhaustive description of the functionality of the software, the different ways in which it can be used, and examples of code usage for different use cases.