extract-zip vs unzipper vs decompress vs decompress-zip
Node.js File Extraction Libraries Comparison
Search packages..
1 Year
extract-zipunzipperdecompressdecompress-zipSimilar Packages:
What's Node.js File Extraction Libraries?

File extraction libraries in Node.js are essential tools for developers who need to handle compressed files in various formats. These libraries provide functionality to decompress and extract files from archives, enabling seamless file management and manipulation within applications. They support different compression formats, making it easier to work with files downloaded from the internet or packaged for distribution. Choosing the right library depends on specific project requirements, such as the types of archives to be handled, performance considerations, and ease of use.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
extract-zip13,871,112392-515 years agoBSD-2-Clause
unzipper3,806,52944956.6 kB807 months agoMIT
decompress3,030,950415-435 years agoMIT
decompress-zip77,232102-284 years agoMIT
Feature Comparison: extract-zip vs unzipper vs decompress vs decompress-zip

Supported Formats

  • extract-zip:

    Exclusively handles .zip files with a straightforward API, making it easy to extract contents without additional complexity.

  • unzipper:

    Primarily focused on .zip files and streams, providing a powerful interface for both extraction and streaming of files.

  • decompress:

    Supports multiple formats including .zip, .tar, .gz, .bz2, and more, allowing for flexible file handling in various scenarios.

  • decompress-zip:

    Specifically designed for .zip files, making it a focused solution for projects that primarily deal with this format.

Ease of Use

  • extract-zip:

    Provides a very straightforward API for extracting .zip files, ideal for developers looking for a no-frills approach.

  • unzipper:

    While slightly more complex, it offers advanced features like streaming extraction, which can be beneficial for larger files.

  • decompress:

    Offers a simple and intuitive API, making it easy for developers to implement file extraction with minimal setup and configuration.

  • decompress-zip:

    Designed for simplicity, it allows quick extraction of .zip files with just a few lines of code, making it beginner-friendly.

Performance

  • extract-zip:

    Highly efficient for .zip files, focusing on performance and speed during extraction operations.

  • unzipper:

    Offers streaming capabilities which can improve performance for large .zip files, allowing for on-the-fly extraction.

  • decompress:

    Performance varies based on the format being extracted, but it is generally efficient for handling multiple formats in a single library.

  • decompress-zip:

    Optimized for .zip files, ensuring quick extraction times and minimal resource usage for this specific format.

Streaming Support

  • extract-zip:

    Does not support streaming; it is a simple extraction tool for .zip files without additional features.

  • unzipper:

    Provides robust streaming support, allowing files to be extracted directly to streams, which is useful for large files or when integrating with other stream-based processes.

  • decompress:

    Does not inherently support streaming, focusing instead on batch extraction of files from various formats.

  • decompress-zip:

    No streaming support; designed for straightforward extraction of .zip files.

Community and Maintenance

  • extract-zip:

    Maintained with a focus on .zip extraction, but may not have as large a community as more general libraries.

  • unzipper:

    Has a solid community and is actively maintained, especially for those needing advanced streaming capabilities.

  • decompress:

    Actively maintained with a growing community, ensuring ongoing support and updates for various formats.

  • decompress-zip:

    Well-maintained, but with a narrower focus on .zip files, which may limit community contributions compared to more versatile libraries.

How to Choose: extract-zip vs unzipper vs decompress vs decompress-zip
  • decompress:

    Choose 'decompress' if you need a versatile library that supports multiple archive formats (including .zip, .tar, .gz, etc.) and want a simple API for extracting files. It is ideal for projects requiring broad format support.

Similar Npm Packages to extract-zip

extract-zip is a Node.js package that provides a simple and efficient way to extract ZIP files. It allows developers to easily handle ZIP file extraction without the need for complex configurations or dependencies. With its straightforward API, extract-zip is particularly useful for applications that require quick and reliable extraction of ZIP archives.

While extract-zip is a great choice for ZIP file extraction, there are other libraries available that offer similar functionality. Here are a couple of alternatives:

  • adm-zip is a popular library for handling ZIP files in Node.js. It provides a comprehensive set of features for creating, reading, and extracting ZIP files. adm-zip supports both synchronous and asynchronous operations, making it versatile for various use cases. If you need more than just extraction—such as creating ZIP files or manipulating their contents—adm-zip is a robust option that offers a rich set of functionalities.
  • unzipper is another library that specializes in extracting ZIP files in a streaming manner. It is designed for performance and efficiency, allowing developers to process large ZIP files without loading them entirely into memory. unzipper is particularly useful for applications that need to handle large datasets or files, as it streams the extraction process, making it suitable for performance-sensitive scenarios.

To see how extract-zip compares with adm-zip and unzipper, check out the comparison: Comparing adm-zip vs extract-zip vs unzipper.

Similar Npm Packages to unzipper

unzipper is a popular npm package for unzipping files in Node.js applications. It provides a simple and efficient way to extract files from ZIP archives, allowing developers to handle compressed files easily. While unzipper is a robust solution for file extraction, there are several alternatives available in the npm ecosystem that also provide similar functionality. Here are a few noteworthy alternatives:

  • adm-zip is a pure JavaScript implementation for reading and writing ZIP files. It offers a straightforward API for creating, extracting, and modifying ZIP archives. adm-zip is particularly useful for applications that require both reading and writing ZIP files, making it a versatile choice for developers looking for a comprehensive solution. Its ease of use and performance make it a popular option for handling ZIP files in Node.js applications.

  • extract-zip is a lightweight and straightforward package specifically designed for extracting ZIP files. It focuses solely on the extraction process, providing a simple API to unzip files with minimal overhead. If your primary requirement is to extract files from ZIP archives without the need for additional features, extract-zip is an excellent choice. Its simplicity and efficiency make it ideal for quick extraction tasks.

  • node-unzip-2 is another alternative for unzipping files in Node.js. It is a fork of the original node-unzip package and provides a streaming interface for extracting files from ZIP archives. This makes it suitable for handling large ZIP files without consuming excessive memory. If you need to process ZIP files in a streaming manner, node-unzip-2 is a solid option that allows for efficient file extraction.

To see how unzipper compares with adm-zip, extract-zip, and node-unzip-2, check out the comparison: Comparing adm-zip vs extract-zip vs node-unzip-2 vs unzipper.

Similar Npm Packages to decompress

decompress is a versatile Node.js package designed for extracting files from various archive formats. It supports multiple formats, including tar, zip, and gzip, making it a convenient choice for developers who need to handle file decompression in their applications. With a simple API, decompress allows users to easily extract files and directories from archives, streamlining the process of managing compressed data.

While decompress is a robust solution for file extraction, there are several alternatives available that cater to specific use cases:

  • decompress-zip is a focused library specifically for extracting ZIP files. It provides a straightforward API for working with ZIP archives, making it an excellent choice if your primary need is to handle ZIP files. With decompress-zip, you can easily extract files, handle errors, and manage the extraction process without the overhead of supporting multiple formats.

  • extract-zip is another specialized library for extracting ZIP files. It offers a simple and efficient way to work with ZIP archives, allowing users to extract files with minimal configuration. extract-zip is particularly useful for developers looking for a lightweight solution that focuses solely on ZIP file extraction, ensuring fast and reliable performance.

  • unzipper is a powerful library that provides streaming support for extracting ZIP files. It allows developers to work with large ZIP files without loading the entire archive into memory, making it a great choice for applications that require efficient handling of large datasets. unzipper offers a more advanced API that supports both extraction and manipulation of ZIP files, giving developers greater control over the extraction process.

To see how decompress compares with decompress-zip, extract-zip, and unzipper, check out the comparison: Comparing decompress vs decompress-zip vs extract-zip vs unzipper.

Similar Npm Packages to decompress-zip

decompress-zip is a Node.js package that provides a simple way to extract ZIP files. It is designed to be easy to use, allowing developers to quickly decompress ZIP archives with minimal setup. This package is particularly useful for applications that need to handle file uploads or downloads in ZIP format, making it a popular choice for file management tasks in Node.js environments. While decompress-zip is effective for its purpose, there are several alternatives available that offer similar functionality. Here are a few noteworthy options:

  • adm-zip is a powerful and versatile library for working with ZIP files in Node.js. It allows users to create, read, and extract ZIP files with a straightforward API. adm-zip supports both synchronous and asynchronous operations, making it suitable for a wide range of applications. If you need more advanced features such as creating ZIP files or handling various compression methods, adm-zip is a solid choice.
  • node-unzip-2 is a simple and efficient library for unzipping files in Node.js. It is a fork of the original node-unzip package and is designed to be lightweight and easy to use. node-unzip-2 streams the contents of ZIP files, which can be beneficial for handling large archives without consuming too much memory. If you are looking for a no-frills solution for extracting ZIP files, node-unzip-2 is worth considering.
  • unzipper is another popular library for extracting ZIP files in Node.js. It provides a streaming interface for unzipping files, allowing developers to process files as they are extracted. This can be particularly useful when working with large ZIP archives or when you need to handle files in real-time. unzipper also supports various features such as extracting specific files and handling password-protected archives, making it a flexible option for developers.

For a comprehensive comparison of these packages, check out the link: Comparing adm-zip vs decompress-zip vs node-unzip-2 vs unzipper.

README for extract-zip

extract-zip

Unzip written in pure JavaScript. Extracts a zip into a directory. Available as a library or a command line program.

Uses the yauzl ZIP parser.

NPM Uses JS Standard Style Build Status

Installation

Make sure you have Node 10 or greater installed.

Get the library:

npm install extract-zip --save

Install the command line program:

npm install extract-zip -g

JS API

const extract = require('extract-zip')

async function main () {
  try {
    await extract(source, { dir: target })
    console.log('Extraction complete')
  } catch (err) {
    // handle any errors
  }
}

Options

  • dir (required) - the path to the directory where the extracted files are written
  • defaultDirMode - integer - Directory Mode (permissions), defaults to 0o755
  • defaultFileMode - integer - File Mode (permissions), defaults to 0o644
  • onEntry - function - if present, will be called with (entry, zipfile), entry is every entry from the zip file forwarded from the entry event from yauzl. zipfile is the yauzl instance

Default modes are only used if no permissions are set in the zip file.

CLI Usage

extract-zip foo.zip <targetDirectory>

If not specified, targetDirectory will default to process.cwd().

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc or npmjs.com, the official website for the npm registry. Please note that npm is a registered trademark of npm, Inc. For more details, please refer to our Terms & Privacy.