zip-iterator

Extract contents from zip archive type using an iterator API using streams or paths. Use stream interface and pipe transforms to add decompression algorithms.

// asyncIterator

1var assert = require('assert');
2var fs = require('fs');
3var ZipIterator = require('zip-iterator'));
4
5(async function() {
6  let iterator = new ZipIterator('/path/to/archive');
7
8  try {
9    const links = [];
10    for await (const entry of iterator) {
11      if (entry.type === 'link') links.unshift(entry);
12      else if (entry.type === 'symlink') links.push(entry);
13      else await entry.create(dest, options);
14    }
15
16    // create links after directories and files
17    for (const entry of links) await entry.create(dest, options);
18  } catch (err) {
19    }
20
21  iterator.destroy();
22  iterator = null;
23})();
24
25(async function() {
26  let iterator = new ZipIterator(fs.createReadStream('/path/to/archive'));
27
28  try {
29    const links = [];
30    for await (const entry of iterator) {
31      if (entry.type === 'link') links.unshift(entry);
32      else if (entry.type === 'symlink') links.push(entry);
33      else await entry.create(dest, options);
34    }
35
36    // create links after directories and files
37    for (const entry of links) await entry.create(dest, options);
38  } catch (err) {
39    }
40
41  iterator.destroy();
42  iterator = null;
43})();

// Async / Await

1var assert = require('assert');
2var ZipIterator = require('zip-iterator'));
3
4// one by one
5(async function() {
6  let iterator = new ZipIterator('/path/to/archive');
7
8  const links = [];
9  let entry = await iterator.next();
10  while (entry) {
11    if (entry.type === 'link') links.unshift(entry);
12    else if (entry.type === 'symlink') links.push(entry);
13    else await entry.create(dest, options);
14    entry = await iterator.next();
15  }
16
17  // create links after directories and files
18  for (entry of links) {
19    await entry.create(dest, options);
20  }
21  iterator.destroy();
22  iterator = null;
23})();
24
25// infinite concurrency
26(async function() {
27  let iterator = new ZipIterator('/path/to/archive');
28
29  try {
30    const links = [];
31    await iterator.forEach(
32      async function (entry) {
33        if (entry.type === 'link') links.unshift(entry);
34        else if (entry.type === 'symlink') links.push(entry);
35        else await entry.create(dest, options);
36      },
37      { concurrency: Infinity }
38    );
39
40    // create links after directories and files
41    for (const entry of links) await entry.create(dest, options);
42  } catch (err) {
43    aseert.ok(!err);
44  }
45
46  iterator.destroy();
47  iterator = null;
48})();

// Callbacks

1var assert = require('assert');
2var Queue = require('queue-cb');
3var ZipIterator = require('zip-iterator'));
4
5var iterator = new ZipIterator('/path/to/archive');
6
7// one by one
8var links = [];
9iterator.forEach(
10  function (entry, callback) {
11    if (entry.type === 'link') {
12      links.unshift(entry);
13      callback();
14    } else if (entry.type === 'symlink') {
15      links.push(entry);
16      callback();
17    } else entry.create(dest, options, callback);
18  },
19  { callbacks: true, concurrency: 1 },
20  function (err) {
21  
22    // create links after directories and files
23    var queue = new Queue();
24    for (var index = 0; index < links.length; index++) {
25      var entry = links[index];
26      queue.defer(entry.create.bind(entry, dest, options));
27    }
28    queue.await(callback);
29
30    iterator.destroy();
31    iterator = null;
32  }
33);