tar-iterator

tar-iterator

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

// asyncIterator

``js
var assert = require('assert');
var fs = require('fs');
var TarIterator = require('tar-iterator');


(async function() {
let iterator = new TarIterator('/path/to/archive');

try {
const links = [];
for await (const entry of iterator) {
if (entry.type === 'link') links.unshift(entry);
else if (entry.type === 'symlink') links.push(entry);
else await entry.create(dest, options);
}

// create links after directories and files
for (const entry of links) await entry.create(dest, options);
} catch (err) {
}

iterator.destroy();
iterator = null;
})();

(async function() {
let iterator = new TarIterator(fs.createReadStream('/path/to/archive'));

try {
const links = [];
for await (const entry of iterator) {
if (entry.type === 'link') links.unshift(entry);
else if (entry.type === 'symlink') links.push(entry);
else await entry.create(dest, options);
}

// create links after directories and files
for (const entry of links) await entry.create(dest, options);
} catch (err) {
}

iterator.destroy();
iterator = null;
})();
`

// Async / Await

`js
var assert = require('assert');
var TarIterator = require('tar-iterator');

// one by one
(async function() {
let iterator = new TarIterator('/path/to/archive');

try {
const links = [];
for await (const entry of iterator) {
if (entry.type === 'link') links.unshift(entry);
else if (entry.type === 'symlink') links.push(entry);
else await entry.create(dest, options);
}

// create links after directories and files
for (const entry of links) await entry.create(dest, options);
} catch (err) {
}

iterator.destroy();
iterator = null;
})();

// infinite concurrency
(async function() {
let iterator = new TarIterator('/path/to/archive');

try {
const links = [];
await iterator.forEach(
async function (entry) {
if (entry.type === 'link') links.unshift(entry);
else if (entry.type === 'symlink') links.push(entry);
else await entry.create(dest, options);
},
{ concurrency: Infinity }
);

// create links after directories and files
for (const entry of links) await entry.create(dest, options);
} catch (err) {
aseert.ok(!err);
}

iterator.destroy();
iterator = null;
})();
`

// Callbacks

`js
var assert = require('assert');
var Queue = require('queue-cb');
var TarIterator = require('tar-iterator');

var iterator = new TarIterator('/path/to/archive');

// one by one
var links = [];
iterator.forEach(
function (entry, callback) {
if (entry.type === 'link') {
links.unshift(entry);
callback();
} else if (entry.type === 'symlink') {
links.push(entry);
callback();
} else entry.create(dest, options, callback);
},
{ callbacks: true, concurrency: 1 },
function (err) {

// create links after directories and files
var queue = new Queue();
for (var index = 0; index < links.length; index++) {
var entry = links[index];
queue.defer(entry.create.bind(entry, dest, options));
}
queue.await(callback);

iterator.destroy();
iterator = null;
}
);
``