@types/yauzl

Opening a zip file

This code demonstrates how to open a zip file using yauzl. It uses the `open` method, specifying the path to the zip file and options, then reads the first entry in the zip file.

import * as yauzl from 'yauzl';
yauzl.open('path/to/file.zip', {lazyEntries: true}, (err, zipfile) => {
  if (err) throw err;
  zipfile.readEntry();
});

Reading entries from a zip file

This code snippet is used within the context of an open zipfile object. It listens for 'entry' events, which occur each time a new entry in the zip file is ready to be read, logging the file name of each entry and then reading the next entry.

zipfile.on('entry', (entry) => {
  console.log(`Entry: ${entry.fileName}`);
  zipfile.readEntry();
});

Extracting file entries

This example shows how to extract files from a zip archive. It checks if the entry is a file (not a directory) and then creates a read stream for that entry. The stream is piped to a write stream that writes the file to a specified output path.

zipfile.on('entry', (entry) => {
  if (/\/.test(entry.fileName)) {
    zipfile.readEntry();
  } else {
    zipfile.openReadStream(entry, (err, readStream) => {
      if (err) throw err;
      readStream.on('end', () => {
        zipfile.readEntry();
      });
      readStream.pipe(fs.createWriteStream('output/path/' + entry.fileName));
    });
  }
});