npmpackage.info

Gathering detailed insights and metrics for adm-zip

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,056

MIT

JavaScript

1,111,409,683 4.8

Installations

npm install adm-zip

Pull Requests

Open

0

Total

174

Closed

28

Merged

146

Issues

Open

139

Total

368

Closed

229

Releases

v0.5.16

Published on 30 Aug 2024

v0.5.15

Published on 05 Aug 2024

v0.5.14

Published on 04 Jun 2024

v0.5.13

Published on 01 Jun 2024

v0.5.12

Published on 14 Mar 2024

v0.5.11

Published on 13 Mar 2024

View all 8 releases

Developer

cthackers

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=12.0

Typescript Support

No

Node Version

22.4.1

NPM Version

10.8.2 Statistics

2,056 Stars

455 Commits

375 Forks

40 Watching

3 Branches

89 Contributors

Updated on 27 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,111,409,683

Last day

-5.5%

1,041,930

Compared to previous day

Last week

5,953,081

Compared to previous week

Last month

24,938,297

Compared to previous month

Last year

22.8%

241,432,167

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

chai iconv-lite mocha prettier rimraf

Versions

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.

Stable Version

The latest stable version of the package.

Stable Version

0.5.16

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.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

SAST

Determines if the project uses static code analysis.

5

Maintained

Determines if the project is "actively maintained".

3

Code-Review

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

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

CII-Best-Practices

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

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.8

/10

Last Scanned on 2024-11-25

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