archiver-zip-encryptable

An extension for archiver to zip with password encryption.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
archiver-zip-encryptable
12121.0.102 years ago5 years agoMinified + gzip package size for archiver-zip-encryptable in KB

Readme

archiver-zip-encryptable
An extension for archiver to zip with password encryption.

GitHub Actions master AppVeyor master Coveralls master npm GitHub license
This extension adds some formats to handle encryption to archiver.
Currently this package supports only creating zip with traditional PKWARE encryption.

Install

npm install archiver-zip-encryptable --save

Usage

Call archiver.registerFormat() to register this module to archiver, then archive with password.
var fs = require('fs');
var archiver = require('archiver');

archiver.registerFormat('zip-encryptable', require('archiver-zip-encryptable'));

var output = fs.createWriteStream(__dirname + '/example.zip');

var archive = archiver('zip-encryptable', {
    zlib: { level: 9 },
    forceLocalTime: true,
    password: 'test'
});
archive.pipe(output);

archive.append(Buffer.from('Hello World'), { name: 'test.txt' });
archive.append(Buffer.from('Good Bye'), { name: 'test2.txt' });

archive.finalize();

Credits

License

MIT