Question 1

How to extract all files from a ZIP archive using yauzl?

Accepted Answer

Use the lazyEntries: true option when opening the zip file, then iterate through entries with readEntry(). For each file entry, call openReadStream() to pipe the data to a destination. The README's Usage section provides a basic example for this pattern.

Question 2

yauzl vs adm-zip: which is better for Node.js?

Accepted Answer

yauzl is better for correctness and memory efficiency with large or spec-compliant archives, as it adheres strictly to the ZIP spec and processes entries lazily. adm-zip might be simpler for basic tasks but can be less reliable and more memory-intensive, especially with many files.

Question 3

Does yauzl support password-protected ZIP files?

Accepted Answer

yauzl can detect encrypted entries using isEncrypted(), but it does not support decryption. If you encounter encrypted files, you'll need to use another library or tool for decryption before processing with yauzl, as noted in the limitations section.

Question 4

How to handle large ZIP files with yauzl without running out of memory?

Accepted Answer

Set lazyEntries: true when calling open() or similar methods to read entries one at a time, and use openReadStream() to stream file contents instead of buffering them. This approach is recommended in the README to control memory usage.

Question 5

yauzl error: how to catch and handle malformed ZIP files?

Accepted Answer

Attach an 'error' event listener to the ZipFile object and to any read streams from openReadStream(). Also, provide callback functions and check err parameters in async methods, as outlined in the 'How to Avoid Crashing' section of the README.

Question 6

Can yauzl read ZIP files from a buffer or stream?

Accepted Answer

yauzl can read from a buffer using fromBuffer(), but not from a readable stream. It requires random access to the entire file, so for streams, you need to buffer the data first or use a different library that supports streaming extraction.

Question 7

What compression methods does yauzl support?

Accepted Answer

yauzl supports only compression method 0 (stored, no compression) and method 8 (deflated). Other methods will cause an error when calling openReadStream(), as mentioned in the limitations under 'No Support For Obscure Compression Methods'.

yauzl

What is yauzl?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions