zip

インストール

const zip = require('archive/zip');

zipSync()

ZIPアーカイブを同期的に作成します。

構文

zipSync(data)

パラメーター

data String | ArrayBuffer | Uint8Array | Number[] | Object[]

dataが単一の文字列またはバイトバッファーの場合、作成するエントリの既定の名前はdataです。配列を渡す場合は、各要素を{ name, data }形式のエントリオブジェクトとして扱います。

戻り値

ZIPアーカイブのバイト列を含むArrayBufferを返します。

簡単なテストや、メモリ上でアーカイブを作成してから別の場所に保存する場合に便利です。

使用例

1
2
3
4
5
6
const zip = require('archive/zip');
const archive = zip.zipSync([
	{ name: 'alpha.txt', data: 'Alpha' },
	{ name: 'dir/beta.txt', data: 'Beta' }
]);
console.println(archive.constructor.name);

1
2
3
4
const zip = require('archive/zip');
const archive = zip.zipSync('hello zip');
const entries = zip.unzipSync(archive);
console.println(entries[0].name, new Uint8Array(entries[0].data).length);

unzipSync()

ZIPアーカイブのバイト列を同期的に展開し、エントリオブジェクトの配列を返します。

構文

unzipSync(buffer)

パラメーター

buffer ArrayBuffer | Uint8Array | Number[]

戻り値

エントリオブジェクトの配列を返します。

各エントリには、name、data、comment、method、compressedSize、size、isDir、 modifiedフィールドを含む場合があります。

使用例

1
2
3
4
5
6
7
8
9
const zip = require('archive/zip');
const archive = zip.zipSync([
	{ name: 'one.txt', data: 'One' },
	{ name: 'two.txt', data: 'Two' }
]);
const entries = zip.unzipSync(archive);
console.println(entries[0].name, entries[0].size);
console.println(entries[1].name, entries[1].size);
console.println(entries.length);

zip()

ZIP作成機能の、コールバック形式の非同期ラッパーです。

構文

zip(data, callback)

コールバックのシグネチャは(err, archive)です。

unzip()

ZIP展開機能の、コールバック形式の非同期ラッパーです。

構文

unzip(buffer, callback)

コールバックのシグネチャは(err, entries)です。

ストリームイベントを直接管理せずに、コールバック方式で処理する場合に適しています。

使用例

1
2
3
4
5
6
7
8
9
const zip = require('archive/zip');

zip.zip('payload', function(err, archive) {
	if (err) throw err;
	zip.unzip(archive, function(err2, entries) {
		if (err2) throw err2;
		console.println(entries[0].name, new Uint8Array(entries[0].data).length);
	});
});

createZip()

ストリーム形式のZIP writerを作成します。

返されるオブジェクトは、write()でエントリを受け取り、end()が呼び出されると、dataイベントでアーカイブのバイト列を出力します。

このAPIはイベント駆動ですが、Node.jsのファイルストリームのように中間結果を逐次出力せず、end()の時点で処理を完了します。

構文

createZip()

createUnzip()

ストリーム形式のZIP readerを作成します。

アーカイブのバイト列をwrite()で渡してからend()を呼び出すと、展開した項目ごとにentryイベントが発生します。

構文

createUnzip()

使用例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
const zip = require('archive/zip');
const writer = zip.createZip();
let archive = null;

writer.on('data', function(chunk) {
	archive = chunk;
});

writer.on('end', function() {
	const reader = zip.createUnzip();
	reader.on('entry', function(entry) {
		const text = String.fromCharCode.apply(null, new Uint8Array(entry.data));
		console.println(entry.name + '=' + text);
	});
	reader.write(archive);
	reader.end();
});

writer.write({ name: 'one.txt', data: 'One' });
writer.write({ name: 'two.txt', data: 'Two' });
writer.end();

Zipは、ZIPアーカイブの作成、保存、読み込み、展開を行うファイル指向のヘルパークラスです。

コンストラクター

new zip.Zip(filePath?)

filePathを指定すると、そのファイルからアーカイブを読み込みます。

addFile()

ファイルシステムのファイルを読み込み、アーカイブエントリとして追加します。

addFile(filePath[, entryName])

addBuffer()

文字列またはバイトバッファーを、アーカイブエントリとして追加します。

addBuffer(data, entryName[, options])

addEntry()

エントリオブジェクトを直接追加します。

addEntry(entry)

対応するZIPエントリのフィールドは以下のとおりです。

name String 必須のエントリパス
data String | ArrayBuffer | Uint8Array | Number[] ファイルの内容
comment String エントリの説明
method Number 圧縮方式

addFile()は、ディスク上にあるファイルをまとめる最も簡単な方法です。 addBuffer()は、メモリ上で生成した内容を直接追加する場合に適しています。 addEntry()は、commentなどのエントリのメタデータも指定する場合に便利です。

getEntries()

現在のアーカイブエントリの浅いコピーを返します。

getEntries()

writeTo()

アーカイブをファイルに保存します。

writeTo(filePath)

extractAllTo()

エントリをディレクトリに展開します。

extractAllTo(outputDir[, overwrite])
extractAllTo(outputDir, options)
extractAllTo(outputDir, overwrite, options)

optionsは、以下の値に対応しています。

overwrite Boolean trueの場合、既存のファイルを上書きします。
filter Function | RegExp | String | String[] 展開するエントリを選択します。

使用例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
const zip = require('archive/zip');

const z = new zip.Zip();
z.addBuffer('hello world', 'app.log');
z.addEntry({ name: 'config.json', data: '{"enabled":true}' });
z.writeTo('/tmp/data.zip');

const saved = new zip.Zip('/tmp/data.zip');
saved.extractAllTo('/tmp/out', {
	overwrite: true,
	filter: function(entry) {
		return entry.name === 'app.log';
	}
});

使用例: ファイルをまとめて再展開する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const fs = require('fs');
const zip = require('archive/zip');
const base = '/tmp/zip-files';

fs.mkdir(base + '/input', { recursive: true });
fs.writeFile(base + '/input/one.txt', 'One', 'utf8');
fs.writeFile(base + '/input/two.txt', 'Two', 'utf8');

const archive = new zip.Zip();
archive.addFile(base + '/input/one.txt');
archive.addFile(base + '/input/two.txt', 'renamed-two.txt');
archive.writeTo(base + '/sample.zip');

const loaded = new zip.Zip(base + '/sample.zip');
loaded.extractAllTo(base + '/out', true);
console.println(fs.readFile(base + '/out/renamed-two.txt', 'utf8'));

使用例: 条件付きの展開

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const zip = require('archive/zip');
const fs = require('fs');
const base = '/tmp/zip-filter';

const archive = zip.zipSync([
	{ name: 'keep/a.txt', data: 'A' },
	{ name: 'keep/b.log', data: 'B' },
	{ name: 'skip/c.txt', data: 'C' }
]);

fs.writeFile(base + '.zip', Array.from(new Uint8Array(archive)), 'buffer');

const loaded = new zip.Zip(base + '.zip');
loaded.extractAllTo(base + '-out', {
	overwrite: true,
	filter: /\.txt$/
});

注意

filterには、コールバック、RegExp、文字列、エントリ名の配列を使用できます。
extractAllTo()は、対象ファイルが存在し、overwriteがfalseの場合にエラーを発生させます。
ZIPエントリのメタデータには、comment、method、compressedSize、sizeを含む場合があります。
ZIPエントリは、TARのsymlinkやlinknameのようなリンクメタデータには対応していません。

最終更新日 9月 10, 2026

tar