zip-a-folder vs adm-zip vs archiver vs jszip vs node-zip vs zip-local

パッケージ	ダウンロード数	Stars	サイズ	Issues	公開日時	ライセンス
パッケージ	ダウンロード数	Stars	サイズ	Issues	公開日時	ライセンス
zip-a-folder	178,749	76	212 kB	0	3日前	MIT
adm-zip	0	2,162	122 kB	144	17日前	MIT
archiver	0	2,950	43.1 kB	156	2年前	MIT
jszip	0	10,339	762 kB	410	-	(MIT OR GPL-3.0-or-later)
node-zip	0	217	-	20	11年前	-
zip-local	0	120	57.1 kB	13	-	-

ストリーミングサポート

zip-a-folder:
zip-a-folderはストリーミング処理をサポートしていません。フォルダー全体を一度に圧縮するため、大きなフォルダーを扱う際にはメモリ使用量が増加します。
adm-zip:
adm-zipはストリーミング処理をサポートしていません。すべてのファイルをメモリに読み込むため、大きなファイルやフォルダーを扱う際にはメモリ使用量が増加します。
archiver:
archiverはストリーミングAPIを提供しており、大きなファイルやフォルダーを効率的に圧縮できます。データを逐次処理するため、メモリ使用量が少なく、パフォーマンスが向上します。
jszip:
jszipはストリーミング処理をサポートしていませんが、ZIPファイルをメモリ内で操作します。大きなファイルを扱う際は、メモリ使用量に注意が必要です。
node-zip:
node-zipはストリーミング処理をサポートしていません。ファイルをメモリに読み込んでから圧縮するため、大きなファイルを扱う際にはメモリ制限があります。
zip-local:
zip-localはストリーミング処理をサポートしていません。ファイルをメモリに読み込んでから圧縮するため、大きなファイルを扱う際にはメモリ制限があります。

フォルダー圧縮

zip-a-folder:
zip-a-folderはフォルダー全体を一度に圧縮することができます。フォルダーのパスを指定するだけで、再帰的にすべてのファイルとサブフォルダーを圧縮します。
adm-zip:
adm-zipはフォルダーを再帰的に圧縮することができますが、フォルダー全体を一度に圧縮する機能はありません。フォルダー内のファイルを個別に圧縮する必要があります。
archiver:
archiverはフォルダーを再帰的に圧縮することができ、サブフォルダーやファイルを含めて一度に圧縮できます。ストリーミング圧縮に対応しているため、大きなフォルダーの圧縮も効率的に行えます。
jszip:
jszipはフォルダーを再帰的に圧縮することができますが、フォルダー全体を一度に圧縮する機能はありません。フォルダー内のファイルを個別に圧縮する必要があります。
node-zip:
node-zipはフォルダーを再帰的に圧縮することができますが、フォルダー全体を一度に圧縮する機能はありません。フォルダー内のファイルを個別に圧縮する必要があります。
zip-local:
zip-localはフォルダーを再帰的に圧縮することができますが、フォルダー全体を一度に圧縮する機能はありません。フォルダー内のファイルを個別に圧縮する必要があります。

ファイル解凍

zip-a-folder:
zip-a-folderは解凍機能を提供していません。圧縮専用のライブラリです。
adm-zip:
adm-zipはZIPファイルからファイルを解凍する機能を提供しています。特定のファイルを指定して解凍することも、全てのファイルを解凍することも可能です。
archiver:
archiverは解凍機能を提供していません。圧縮専用のライブラリです。
jszip:
jszipはZIPファイルからファイルを解凍する機能を提供しています。特定のファイルを指定して解凍することも、全てのファイルを解凍することも可能です。
node-zip:
node-zipはZIPファイルからファイルを解凍する機能を提供しています。特定のファイルを指定して解凍することも、全てのファイルを解凍することも可能です。
zip-local:
zip-localはZIPファイルからファイルを解凍する機能を提供しています。特定のファイルを指定して解凍することも、全てのファイルを解凍することも可能です。

APIのシンプルさ

zip-a-folder:
zip-a-folderは非常にシンプルなAPIを提供しており、フォルダーを圧縮する作業が簡単に行えます。
adm-zip:
adm-zipはシンプルで直感的なAPIを提供しており、特に小規模なプロジェクトや簡単なZIP操作に適しています。
archiver:
archiverはストリーミングAPIを提供していますが、やや複雑なため、大規模なプロジェクトや専門的な用途に適しています。
jszip:
jszipはシンプルで使いやすいAPIを提供しており、特にクライアントサイドでのファイル操作に強みがあります。
node-zip:
node-zipはシンプルで直感的なAPIを提供しており、特に小規模なプロジェクトに適しています。
zip-local:
zip-localはシンプルで直感的なAPIを提供しており、特にローカル環境でのファイル操作に特化しています。

Ease of Use: Code Examples

zip-a-folder:

zip-a-folderを使用したフォルダーの圧縮の例

const { zip } = require('zip-a-folder');

zip('myFolder', 'example.zip').then(() => {
  console.log('フォルダーが圧縮されました。');
});

adm-zip:

adm-zipを使用したZIPファイルの作成と解凍の例

const AdmZip = require('adm-zip');

// ZIPファイルの作成
const zip = new AdmZip();
zip.addFile('hello.txt', Buffer.from('Hello, World!'));
zip.addLocalFolder('myFolder');
zip.writeZip('example.zip');

// ZIPファイルの解凍
const zipFile = new AdmZip('example.zip');
zipFile.extractAllTo('outputFolder', true);

archiver:

archiverを使用したストリーミングZIPファイルの作成の例

const fs = require('fs');
const archiver = require('archiver');

const output = fs.createWriteStream('example.zip');
const archive = archiver('zip');

output.on('close', () => {
  console.log(`ZIPファイルが作成されました: ${archive.pointer()} バイト`);
});

archive.pipe(output);
archive.append('Hello, World!', { name: 'hello.txt' });
archive.directory('myFolder/', 'myFolder');
archive.finalize();

jszip:

jszipを使用したZIPファイルの作成と解凍の例

const JSZip = require('jszip');
const fs = require('fs');

const zip = new JSZip();
zip.file('hello.txt', 'Hello, World!');
zip.folder('myFolder').file('file.txt', 'This is a file.');

zip.generateAsync({ type: 'nodebuffer' }).then((content) => {
  fs.writeFileSync('example.zip', content);
  console.log('ZIPファイルが作成されました。');

  // ZIPファイルの解凍
  const unzip = new JSZip();
  fs.readFile('example.zip', (err, data) => {
    unzip.loadAsync(data).then((zip) => {
      zip.file('hello.txt').async('string').then((content) => {
        console.log(content); // 'Hello, World!'
      });
      zip.folder('myFolder').file('file.txt').async('string').then((content) => {
        console.log(content); // 'This is a file.'
      });
    });
  });
});

node-zip:

node-zipを使用したZIPファイルの作成と解凍の例

const zip = require('node-zip')();
const fs = require('fs');

// ZIPファイルの作成
zip.file('hello.txt', 'Hello, World!');
zip.folder('myFolder').file('file.txt', 'This is a file.');
const data = zip.generate({ base64: false });
fs.writeFileSync('example.zip', data, 'binary');

// ZIPファイルの解凍
const unzip = require('node-zip')();
const zipData = fs.readFileSync('example.zip', 'binary');
unzip.load(zipData);
console.log(unzip.files['hello.txt'].data.toString()); // 'Hello, World!'
console.log(unzip.files['myFolder/file.txt'].data.toString()); // 'This is a file.'

zip-local:

zip-localを使用したZIPファイルの作成と解凍の例

const zipLocal = require('zip-local');
const fs = require('fs');

// ZIPファイルの作成
zipLocal.zip('myFolder', (err, zip) => {
  if (err) throw err;
  zip.save('example.zip', () => {
    console.log('ZIPファイルが作成されました。');

    // ZIPファイルの解凍
    zip.extract('outputFolder', () => {
      console.log('ZIPファイルが解凍されました。');
    });
  });
});

Option	Type	Description
`comment`	`string`	ZIP file comment
`forceLocalTime`	`boolean`	Use local timestamps instead of UTC
`forceZip64`	`boolean`	Always include ZIP64 headers
`namePrependSlash`	`boolean`	Prefix all ZIP entry names with `/`
`store`	`boolean`	Force STORE method (no compression)
`zlib`	`ZlibOptions`	Passed directly to `zlib.deflateRaw`
`statConcurrency`	`number`	Parallel `stat` workers (default: 4)
`destPath`	`string`	Prefix inside the archive (>=3.1)
`exclude`	`string[]`	Glob patterns for paths to omit
`customWriteStream`	`WriteStream`	Manually handle output

Option	Type	Description
`compressionType`	`'none' \| 'gzip' \| 'brotli'`	Compression algorithm (default: `'gzip'`)
`gzip`	`boolean`	Enable gzip compression (deprecated, use `compressionType`)
`gzipOptions`	`ZlibOptions`	Passed to `zlib.createGzip`
`brotliOptions`	`BrotliOptions`	Passed to `zlib.createBrotliCompress`
`statConcurrency`	`number`	Parallel `stat` workers
`exclude`	`string[]`	Glob patterns to omit
`compression`	`COMPRESSION_LEVEL`	Convenience preset (`high`, `medium`, `uncompressed`)

Option	Type	Description
`compression`	`COMPRESSION_LEVEL`	Convenience preset (`high`, `medium`, `uncompressed`)
`compressionLevel`	`number` (1-9)	LZMA compression level (default: 5)
`statConcurrency`	`number`	Parallel `stat` workers (default: 4)
`exclude`	`string[]`	Glob patterns to omit
`customWriteStream`	`WriteStream`	Manually handle output

Extension	Description
`.zip`	ZIP archive (deflate compression)
`.tar`	TAR archive (uncompressed)
`.tgz`	TAR archive with gzip compression
`.tar.gz`	TAR archive with gzip compression
`.tar.br`	TAR archive with brotli compression
`.7z`	7z archive with LZMA compression

Option	Description
`-h, --help`	Show help message
`-V, --version`	Show version number
`-v, --verbose`	Show detailed progress (files being processed)
`-q, --quiet`	Suppress all output except errors
`-c, --compression <level>`	Compression preset: `high`, `medium`, `uncompressed`
`-l, --level <number>`	Compression level (1-9, format-specific)
`-e, --exclude <pattern>`	Glob pattern to exclude (can be used multiple times)
`-d, --dest-path <path>`	Destination path prefix inside archive

ZIPファイル操作

npmのダウンロードトレンド

GitHub Starsランキング

統計詳細

機能比較: zip-a-folder vs adm-zip vs archiver vs jszip vs node-zip vs zip-local

ストリーミングサポート

フォルダー圧縮

ファイル解凍

APIのシンプルさ

Ease of Use: Code Examples

選び方: zip-a-folder vs adm-zip vs archiver vs jszip vs node-zip vs zip-local

人気の比較

zip-a-folderと類似したnpmパッケージ

adm-zipと類似したnpmパッケージ

archiverと類似したnpmパッケージ

jszipと類似したnpmパッケージ

node-zipと類似したnpmパッケージ

zip-localと類似したnpmパッケージ

zip-a-folder のREADME

zip-a-folder

Table of Contents

Incompatible Changes

Version 2

Version 3

Version 3.1

Version 4

Version 5

Version 6 (current)

Installation

Usage

Create a ZIP file

Create a GZIP-compressed TAR file (.tgz)

Compression Handling

ZIP Options

TAR / TGZ / TAR.BR Options

Gzip Example

Brotli Example

Uncompressed TAR

7z Options

Basic Example

With Compression Level

With Glob Patterns

With Exclusions

Custom Write Streams

Glob Handling

Destination Path Handling (destPath)

Directory Root Inclusion Semantics

Include the directory itself

Summary

Excluding Files and Directories (exclude)

Module Import Structure

Native Implementation Notes

Unix Permissions Preservation in ZIP

Command Line Interface (CLI)

Installation

Usage

Supported Formats

Options

Examples

Output

Running Tests

Thanks

Create a GZIP-compressed TAR file (`.tgz`)

Destination Path Handling (`destPath`)

Excluding Files and Directories (`exclude`)