How to create a zip file from a stream in yazl?

Use addReadStreamLazy for lazy stream addition or addReadStream for immediate addition. Pipe the outputStream to a writable stream to generate the zip incrementally without full buffering, as shown in the usage examples.

yazl vs archiver for Node.js zip creation – which is better?

yazl offers low-level control with async streaming and memory efficiency, ideal for large files and custom workflows. Archiver provides a higher-level API with features like progress events, better for convenience and rapid development.

Does yazl support files larger than 4GB?

Yes, it automatically uses ZIP64 format for files and archives over 4GB. However, note that some tools like Mac Archive Utility don't support ZIP64, so compatibility may vary.

How to set compression level in yazl?

Pass the compressionLevel option in methods like addFile or addBuffer. For example, set compressionLevel: 9 for max compression or 0 for no compression, as documented in the API section.

How to handle errors when creating a zip with yazl?

Listen for error events on the ZipFile instance. The library emits errors for issues like invalid paths, but error handling isn't well-tested, so implement robust fallbacks and validation.

Can yazl create zip files compatible with Mac Archive Utility?

Yes, but avoid ZIP64 format as it's unsupported. Use forceDosTimestamp option and ensure methods like addBuffer are used for all entries to work around 7-Zip bugs, as noted in compatibility sections.

yazl — Node.js ZIP Archive Library

What is yazl?

yazl is a Node.js library for creating ZIP archive files programmatically. It allows developers to add files, buffers, and streams to a ZIP archive with support for async operations and streaming output. The library solves the problem of generating ZIP files efficiently without blocking the event loop or consuming excessive memory.

Target Audience

Node.js developers who need to generate ZIP archives in applications such as file backup systems, data export features, or package distribution tools.

Value Proposition

Developers choose yazl for its non-blocking async APIs, memory-efficient streaming design, and built-in support for large files via ZIP64. It offers fine-grained control over compression and compatibility options.

yet another zip library for node

Use Cases

Best For

Generating ZIP archives from dynamic file sources in Node.js applications
Creating large ZIP files without buffering entire contents in memory
Streaming ZIP output directly to HTTP responses or file systems
Building tools that package multiple files for download or distribution
Handling ZIP creation with custom read streams or buffers
Ensuring compatibility with specific unzip tools like 7-Zip or Mac Archive Utility

Not Ideal For

Applications that need to both create and extract ZIP files within the same library
Projects requiring synchronous ZIP creation for simple, blocking scripts
Use cases where compatibility with unzip tools that don't support ZIP64, like Mac Archive Utility, is essential
Scenarios involving very large in-memory buffers exceeding 0x3fffffff bytes

Pros & Cons

Pros

Async Non-Blocking Design

Uses asynchronous APIs to prevent blocking the JavaScript thread, as emphasized in its design principles for efficient I/O handling in Node.js.

Memory-Efficient Streaming

Avoids buffering entire files in RAM by piping read streams and output streams, keeping memory usage minimal even for large archives, as detailed in the streaming support feature.

Automatic ZIP64 Support

Seamlessly handles files and archives over 4GB by switching to ZIP64 format without manual configuration, ensuring compatibility with large data sets.

Flexible Input Sources

Supports adding files from filesystem, buffers, and custom read streams via methods like addFile, addBuffer, and addReadStreamLazy, offering versatility for different data sources.

Cons

No Extraction Capability

Only creates ZIP files; for unzipping, developers must integrate a separate library like yauzl, adding complexity and dependency management overhead.

Performance Sacrifice for Resource Safety

Opens input files one at a time to avoid OS limits on open file handles, which can slow down archiving compared to parallel approaches, as admitted in the philosophy section.

Buffer Size Constraint

The addBuffer method is limited to buffers of at most 0x3fffffff bytes due to zlib and Node.js constraints, restricting its use for extremely large in-memory data.

What is yazl?

Target Audience

Node.js developers who need to generate ZIP archives in applications such as file backup systems, data export features, or package distribution tools.

Value Proposition

Use Cases

Best For

Generating ZIP archives from dynamic file sources in Node.js applications
Creating large ZIP files without buffering entire contents in memory
Streaming ZIP output directly to HTTP responses or file systems
Building tools that package multiple files for download or distribution
Handling ZIP creation with custom read streams or buffers
Ensuring compatibility with specific unzip tools like 7-Zip or Mac Archive Utility

Not Ideal For

Applications that need to both create and extract ZIP files within the same library
Projects requiring synchronous ZIP creation for simple, blocking scripts
Use cases where compatibility with unzip tools that don't support ZIP64, like Mac Archive Utility, is essential
Scenarios involving very large in-memory buffers exceeding 0x3fffffff bytes

Pros & Cons

Pros

Async Non-Blocking Design

Uses asynchronous APIs to prevent blocking the JavaScript thread, as emphasized in its design principles for efficient I/O handling in Node.js.

Memory-Efficient Streaming

Avoids buffering entire files in RAM by piping read streams and output streams, keeping memory usage minimal even for large archives, as detailed in the streaming support feature.

Automatic ZIP64 Support

Seamlessly handles files and archives over 4GB by switching to ZIP64 format without manual configuration, ensuring compatibility with large data sets.

Flexible Input Sources

Supports adding files from filesystem, buffers, and custom read streams via methods like addFile, addBuffer, and addReadStreamLazy, offering versatility for different data sources.

Cons

No Extraction Capability

Only creates ZIP files; for unzipping, developers must integrate a separate library like yauzl, adding complexity and dependency management overhead.

Performance Sacrifice for Resource Safety

Opens input files one at a time to avoid OS limits on open file handles, which can slow down archiving compared to parallel approaches, as admitted in the philosophy section.

Buffer Size Constraint

The addBuffer method is limited to buffers of at most 0x3fffffff bytes due to zlib and Node.js constraints, restricting its use for extremely large in-memory data.

yazl

What is yazl?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

yazl

What is yazl?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?