node-7z

node-7z

A Node.js wrapper for 7-Zip

Usage

I chose to use Promises in this library. API is consistent with standard use:

var Zip = require('7z'); // Name the class as you want!
var myTask = new Zip();
myTask.extractFull('myArchive.7z', 'destination', { p: 'myPassword' })

// Equivalent to `on('data', function (files) { // ... });`
.progress(function (files) {
  console.log('Some files are extracted: %s', files);
});

// When all is done
.then(function () {
  console.log('Extracting done!');
});

// On error
.catch(function (err, code) {
  console.error('7-Zip exit with code %i', code);
  console.error(err);
});

Installation

You must have the 7z executable available in your PATH. In some GNU/Linux distributions install the p7zip-full.

npm install --save 7z

API

Extract: Zip.extract

Arguments

• archive The path to the archive you want to analyse.
• dest Where to extract the archive.
• options An object of options.

Progress

• files A array of all the extracted files AND directories. The / character is used as a path separator on every platform.

Error

• err An Error object.

Extract with full paths: Zip.extractFull

Arguments

• archive The path to the archive you want to analyse.
• dest Where to extract the archive.
• options An object of options.

Progress

• files A array of all the extracted files AND directories. The / character is used as a path separator on every platform.

Error

• err An Error object.

Test integrity of archive: Zip.test

Arguments

• archive The path to the archive you want to analyse.
• options An object of options.

Progress

• files A array of all the extracted files AND directories. The / character is used as a path separator on every platform.

Error

• err An Error object.

List contents of archive: Zip.list

Arguments

• archive The path to the archive you want to analyse.
• options An object of options.

Progress

• files A array of all the extracted files AND directories. The / character is used as a path separator on every platform.

Fulfill

• spec An object of tech spec about the archive. Properties are: date, attr, size and name.

Error

• err An Error object.

---

With :heart: from quentinrossetti