zip-lib

zip and unzip library for node.

Install

npm install zip-lib

Quick Start

• Zip
  • Zip single file
  • Zip single folder
• Unzip
• Advanced usage
  • Sets the compression level
  • Zip multiple files and folders
  • Zip with metadata
  • Unzip with entry callback
  • Unzip and exclude specified entries
  • Cancel zip
  • Cancel unzip
• API
  • Method: archiveFile
  • Method: archiveFolder
  • Method: extract
  • Class: Zip
  • Class: Unzip
  • Options: IZipOptions
  • Options: IExtractOptions

Zip

You can use zip-lib to compress files or folders.

Zip single file

1const zl = require("zip-lib");
2
3zl.archiveFile("path/to/file.txt", "path/to/target.zip").then(function () {
4    console.log("done");
5}, function (err) {
6    console.log(err);
7});

Zip single folder

1const zl = require("zip-lib");
2
3zl.archiveFolder("path/to/folder", "path/to/target.zip").then(function () {
4    console.log("done");
5}, function (err) {
6    console.log(err);
7});

Unzip

1const zl = require("zip-lib");
2
3zl.extract("path/to/target.zip", "path/to/target").then(function () {
4    console.log("done");
5}, function (err) {
6    console.log(err);
7});

Advanced usage

Sets the compression level

1const zl = require("zip-lib");
2
3zl.archiveFolder("path/to/folder", "path/to/target.zip", { compressionLevel: 9 }).then(function () {
4    console.log("done");
5}, function (err) {
6    console.log(err);
7});

Zip multiple files and folders

1const zl = require("zip-lib");
2
3const zip = new zl.Zip();
4// Adds a file from the file system
5zip.addFile("path/to/file.txt");
6// Adds a folder from the file system, putting its contents at the root of archive
7zip.addFolder("path/to/folder");
8// Generate zip file.
9zip.archive("path/to/target.zip").then(function () {
10    console.log("done");
11}, function (err) {
12    console.log(err);
13});

The path/to/folder directory is as follows:

path/to/folder
.
├── dir1
│   ├── file.ext
├── dir2
└── file_in_root.ext

And the generated path/to/target.zip archive file directory will be as follows:

path/to/target.zip
.
├── file.txt
├── dir1
│   ├── file.ext
├── dir2
└── file_in_root.ext

Zip with metadata

1const zl = require("zip-lib");
2
3const zip = new zl.Zip();
4// Adds a file from the file system
5zip.addFile("path/to/file.txt", "renamedFile.txt");
6zip.addFile("path/to/file2.txt", "folder/file.txt");
7// Adds a folder from the file system, and naming it `new folder` within the archive
8zip.addFolder("path/to/folder", "new folder");
9// Generate zip file.
10zip.archive("path/to/target.zip").then(function () {
11    console.log("done");
12}, function (err) {
13    console.log(err);
14});

The path/to/folder directory is as follows:

path/to/folder
.
├── dir1
│   ├── file.ext
├── dir2
└── file_in_root.ext

And the generated path/to/target.zip archive file directory will be as follows:

path/to/target.zip
.
├── renamedFile.txt
├── folder
│   ├── file.txt
│── new folder
    ├── dir1
    │   ├── file.ext
    ├── dir2
    └── file_in_root.ext

Unzip with entry callback

Using onEntry callback we can know the current progress of extracting and control the extraction operation. See IExtractOptions.

1const zl = require("zip-lib");
2
3const unzip = new zl.Unzip({
4    // Called before an item is extracted.
5    onEntry: function (event) {
6        console.log(event.entryCount, event.entryName);
7    }
8})
9unzip.extract("path/to/target.zip", "path/to/target").then(function () {
10    console.log("done");
11}, function (err) {
12    console.log(err);
13});

Unzip and exclude specified entries

The following code shows how to exclude the __MACOSX folder in the zip file when extracting. See IExtractOptions.

1const zl = require("zip-lib");
2
3const unzip = new zl.Unzip({
4    // Called before an item is extracted.
5    onEntry: function (event) {
6        if (/^__MACOSX\//.test(event.entryName)) {
7            // entry name starts with __MACOSX/
8            event.preventDefault();
9        }
10    }
11})
12unzip.extract("path/to/target.zip", "path/to/target").then(function () {
13    console.log("done");
14}, function (err) {
15    console.log(err);
16});

Cancel zip

If the cancel method is called after the archive is complete, nothing will happen.

1const zl = require("zip-lib");
2
3const zip = new zl.Zip();
4zip.addFile("path/to/file.txt");
5zip.archive("path/to/target.zip").then(function () {
6    console.log("done");
7}, function (err) {
8    if (err.name === "Canceled") {
9        console.log("cancel");
10    } else {
11        console.log(err);
12    }
13});
14
15// Cancel zip
16zip.cancel();

Cancel unzip

If the cancel method is called after the extract is complete, nothing will happen.

1const zl = require("zip-lib");
2
3const unzip = new zl.Unzip();
4unzip.extract("path/to/target.zip", "path/to/target").then(function () {
5    console.log("done");
6}, function (err) {
7    if (err.name === "Canceled") {
8        console.log("cancel");
9    } else {
10        console.log(err);
11    }
12});
13
14// cancel
15unzip.cancel();

API

Method: archiveFile

archiveFile(file, zipFile, [options])

Compress a single file to zip.

• file: String
• zipFile: String
• options?: IZipOptions (optional)

Returns: Promise<viod>

Method: archiveFolder

archiveFolder(folder, zipFile, [options])

Compress all the contents of the specified folder to zip.

• folder: String
• zipFile: String
• options?: IZipOptions (optional)

Returns: Promise<void>

Method: extract

extract(zipFile, targetFolder, [options])

Extract the zip file to the specified location.

• zipFile: String
• targetFolder: String
• options?: IExtractOptions (optional)

Returns: Promise<void>

Class: Zip

Compress files or folders to a zip file.

Constructor: new Zip([options])

• options?: IZipOptions

Method: addFile(file, [metadataPath])

Adds a file from the file system at realPath into the zipfile as metadataPath.

• file: String
• metadataPath?: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with / or /[A-Za-z]:\//, and must not contain ...

Returns: void

Method: addFolder(folder, [metadataPath])

Adds a folder from the file system at realPath into the zipfile as metadataPath.

• folder: String
• metadataPath?: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with / or /[A-Za-z]:\//, and must not contain ...

Returns: void

Method: archive(zipFile)

Generate zip file.

• zipFile: String

Returns: Promise<viod>

Method: cancel()

Cancel compression. If the cancel method is called after the archive is complete, nothing will happen.

Returns: void

Class: Unzip

Extract the zip file.

Constructor: new Unzip([options])

• options?: IZipOptions (optional)

Method: extract(zipFile, targetFolder)

Extract the zip file to the specified location.

• zipFile: String
• targetFolder: String

Returns: Promise<void>

Method: cancel()

If the cancel method is called after the extract is complete, nothing will happen.

Returns: void

Options: IZipOptions

Object

• followSymlinks?: Boolean (optional) - Indicates how to handle when the given path is a symbolic link. The default value is false.
  true: add the target of the symbolic link to the zip.
  false: add symbolic link itself to the zip.
• compressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 - Sets the compression level. The default value is 6.
  0: the file data will be stored.
  1-9: the file data will be deflated.

Options: IExtractOptions

Object

• overwrite?: String (optional) - If it is true, the target directory will be deleted before extract. The default value is false.

• symlinkAsFileOnWindows?: Boolean (optional) - Extract symbolic links as files on Windows. This value is only available on Windows and ignored on other platforms. The default value is true.
  If true, the symlink in the zip will be extracted as a normal file on Windows.
  If false, the symlink in the zip will be extracted as a symlink correctly on Windows, but an EPERM error will be thrown under non-administrators.

  ⚠WARNING: On Windows, the default security policy allows only administrators to create symbolic links. If you set symlinkAsFileOnWindows to false and the zip contains symlink, be sure to run the code under the administrator, otherwise an EPERM error will be thrown.

• onEntry?: Function (optional) - Called before an item is extracted.
  Arguments:

  • event: Object - Represents an event that an entry is about to be extracted.
    • entryName: String (readonly) - Entry name.
    • entryCount: Number (readonly) - Total number of entries.
    • preventDefault(): Function - Prevent extracting current entry. This method can be used to prevent extraction of the current item. By calling this method we can control which items can be extracted.

License

Licensed under the MIT license.