npmpackage.info

Gathering detailed insights and metrics for adm-zip

Other packages similar to adm-zip

@types/adm-zip

0.5.7

TypeScript definitions for adm-zip

qiao-zip

4.9.4

nodejs zip and unzip tool

jaswude-adm-zip

0.5.15

基于adm-zip 0.5.9，解决解压文件名中文乱码问题

adm-zip-iconv

0.4.9

A Javascript implementation of zip for nodejs. Allows user to create or extract zip files both in memory or to/from disk

Gathering detailed insights and metrics for adm-zip

adm-zip - 0.5.16 | npmpackage.info

adm-zip

A Javascript implementation of zip for nodejs. Allows user to create or extract zip files both in memory or to/from disk

0.5.16

2,100

MIT

JavaScript

11.24 kB

1,241,529,357 4.1

Installations

npm install adm-zip

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=12.0

Node Version

22.4.1

NPM Version

10.8.2 Score

99.8

Supply Chain

96.1

Quality

79.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

176

Closed

28

Merged

146

Issues

Open

143

Total

374

Closed

231

Releases

v0.5.16

Updated on Aug 30, 2024

v0.5.15

Updated on Aug 05, 2024

v0.5.14

Updated on Jun 04, 2024

v0.5.13

Updated on Jun 01, 2024

v0.5.12

Updated on Mar 14, 2024

v0.5.11

Updated on Mar 13, 2024

View All 8 releases

Languages

JavaScript

JavaScript (100%)

Developer

cthackers

Download Statistics

Total Downloads

1,241,529,357

Last Day

1,254,062

Last Week

7,408,210

Last Month

28,880,856

Last Year

284,123,880

GitHub Statistics

MIT License

2,100 Stars

455 Commits

374 Forks

39 Watchers

4 Branches

89 Contributors

Updated on Apr 29, 2025

Bundle Size

33.56 kB

Minified

11.24 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 89 Contributors

Package Meta Information

Latest Version

0.5.16

Package Id

adm-zip@0.5.16

Unpacked Size

118.64 kB

Size

26.42 kB

File Count

NPM Version

10.8.2

Node Version

22.4.1

Published on

Aug 30, 2024

Total Downloads

Cumulative downloads

Total Downloads

1,241,529,357

Dev Dependencies

chai iconv-lite mocha prettier rimraf

ADM-ZIP for NodeJS

ADM-ZIP is a pure JavaScript implementation for zip data compression for NodeJS.

Installation

With npm do:

$ npm install adm-zip

Electron file system support described below.

What is it good for?

The library allows you to:

decompress zip files directly to disk or in memory buffers
compress files and store them to disk in .zip format or in compressed buffers
update content of/add new/delete files from an existing .zip

Dependencies

There are no other nodeJS libraries that ADM-ZIP is dependent of

Examples

Basic usage

1var AdmZip = require("adm-zip");
2
3// reading archives
4var zip = new AdmZip("./my_file.zip");
5var password = "1234567890";
6var zipEntries = zip.getEntries(); // an array of ZipEntry records - add password parameter if entries are password protected
7
8zipEntries.forEach(function (zipEntry) {
9    console.log(zipEntry.toString()); // outputs zip entries information
10    if (zipEntry.entryName == "my_file.txt") {
11        console.log(zipEntry.getData().toString("utf8"));
12    }
13});
14// outputs the content of some_folder/my_file.txt
15console.log(zip.readAsText("some_folder/my_file.txt"));
16// extracts the specified file to the specified location
17zip.extractEntryTo(/*entry name*/ "some_folder/my_file.txt", /*target path*/ "/home/me/tempfolder", /*maintainEntryPath*/ false, /*overwrite*/ true);
18// extracts everything
19zip.extractAllTo(/*target path*/ "/home/me/zipcontent/", /*overwrite*/ true);
20
21// creating archives
22var zip = new AdmZip();
23
24// add file directly
25var content = "inner content of the file";
26zip.addFile("test.txt", Buffer.from(content, "utf8"), "entry comment goes here");
27// add local file
28zip.addLocalFile("/home/me/some_picture.png");
29// get everything as a buffer
30var willSendthis = zip.toBuffer();
31// or write everything to disk
32zip.writeZip(/*target file name*/ "/home/me/files.zip");
33
34// ... more examples in the wiki

For more detailed information please check out the wiki.

Electron original-fs

ADM-ZIP has supported electron original-fs for years without any user interractions but it causes problem with bundlers like rollup etc. For continuing support original-fs or any other custom file system module. There is possible specify your module by fs option in ADM-ZIP constructor.

Example:

1const AdmZip = require("adm-zip");
2const OriginalFs = require("original-fs");
3
4// reading archives
5const zip = new AdmZip("./my_file.zip", { fs: OriginalFs });
6.
7.
8.

Moderate

5.5/10

Summary

Arbitrary File Write in adm-zip

Affected Versions

< 0.4.11

Patched Versions

0.4.11

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.1

/10

Last Scanned on 2025-04-21

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to adm-zip

Other packages similar to adm-zip

adm-zip

Installations

Developer Guide

No

CommonJS

>=12.0

22.4.1

10.8.2

Score

Pull Requests

2

176

28

146

Issues

143

374

231

Releases

Languages

Developer

cthackers

Download Statistics

GitHub Statistics

Bundle Size

33.56 kB

11.24 kB

Maintainers

Package Meta Information

Total Downloads

1,241,529,357

Dev Dependencies

ADM-ZIP for NodeJS

Installation

What is it good for?

Dependencies

Examples

Basic usage

Electron original-fs

10

10

10

9

8

3

0

0

0

0

0

0

0

4.1

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads