Usage

importSevenfrom'node-7z'// myStream is a Readable streamconstmyStream=Seven.extractFull('./archive.7z','./output/dir/',{$progress:true})myStream.on('data',function(data){doStuffWith(data)//? { status: 'extracted', file: 'extracted/file.txt" }})myStream.on('progress',function(progress){doStuffWith(progress)//? { percent: 67, fileCount: 5, file: undefinded }})myStream.on('end',function(){// end of the operation, get the number of folders involved in the operationmyStream.info.get('Folders')//? '4'})myStream.on('error',(err)=>handleError(err))

Table of content

Installation

npm install --save node-7z

importsevenBinfrom'7zip-bin'import{extractFull}from'node-7z'constpathTo7zip=sevenBin.path7zaconstseven=extractFull('./archive.7z','./output/dir/',{$bin:pathTo7zip})

API

Commands

Add

// adds all *.txt files from current folder and its subfolders to archive Files.7z.constmyStream=Seven.add('Files.7z','*.txt',{recursive:true})

Delete

// deletes *.bak files from archive archive.zip.constmyStream=Seven.delete('archive.zip','*.bak')

Extract

// extracts all *.cpp files from archive archive.zip to c:\soft folder.constmyStream=Seven.extract('archive.zip','c:/soft',{recursive:true,$cherryPick:'*.cpp'})

Extract with full paths

// extracts all *.cpp files from the archive archive.zip to c:\soft folder.constmyStream=Seven.extractFull('archive.zip','c:/soft',{recursive:true,$cherryPick:'*.cpp'})

Hash

// calculates SHA256 for a.iso.constmyStream=Seven.hash('a.iso',{hashMethod:'sha256'})

List

// list all the *.txt and *.js files in archive.zipconstmyStream=Seven.list('archive.zip',{$cherryPick:['*.txt*','*.js'],})

Rename

// renames old.txt to new.txt and 2.txt to folder\2new.txt .constmyStream=Seven.rename('a.7z',[['old.txt','new.txt'],['2.txt','folder/2new.txt']])

Test integrity

// tests *.doc files in archive archive.zip.constmyStream=Seven.list('archive.zip',{recursive:true,$cherryPick:'*.doc'})

Update

// updates *.doc files to archive archive.zip.constmyStream=Seven.add('archive.zip','*.doc')

Options

Switches

Special options

Events

Event:data

mySevenStream.on('data',function(data){console.log(data)// {//   file: 'path/of/the/file/in/the/archive',//   status: 'renamed|tested|updated|skipped|deleted|extracted',//   attributes: '....A', size: 9, sizeCompressed: 3, (only list command)//   hash: 'FEDC304F', size: 9 (only hash command)//   techInfo: Map(8) { (only list command with `techInfo` switch)//      'Path' => 'DirHex/sub2/e825776890f2b',//      'Size' => '9',//      'Modified' => '2018-09-29 09:06:15',//      'Attributes' => 'A_ -rw-r--r--',//      'CRC' => 'FEDC304F',//      'Encrypted' => '-',//      'Method' => 'LZMA2:12',//      'Block' => '0'//   }// }})

Event:end

myStream.info// Map {//   '7-Zip [64] 16.02 ' => 'Copyright (c) 1999-2016 Igor Pavlov : 2016-05-21',//   'Creating archive' => './test/_tmp/txt-and-md-only.7z',//   'Items to compress' => '6',//   'Files read from disk' => '6',//   'Archive size' => '212 bytes (1 KiB)' }

Event:error

mySevenStream.on('error',function(err){// a standard error// `err.stderr` is a string that can contain extra info about the error})

Advanced usage

Compression method

# adds all .exe files to solid archive archive.7z using the LZMA method# with 2 MB dictionary and BCJ filter.7z a archive.7z*.exe -m0=BCJ -m1=LZMA:d=21

constcompress=Seven.add('archive.7z','*.exe',{method:['0=BCJ','1=LZMA:d=21']})

Encrypt metadata (hide filenames in password protected archives)

# adds all .exe files with a password and also encrypt metadata, thus hiding filenames7z a archive.7z*.exe -p -mhe

constcompress=Seven.add('archive.7z','*.exe',{password:"your-password-here",method:['he']})

Raw inputs

constcompress=Seven.add('archive.7z','*.gif',{$raw:['-i!*.jpg','-i!*.png'],// only images})

Emoji and Unicode

Log level

Security

External child process

constexternal=// an external child processconstmyStream=Seven.add('dummy','dummy',{$defer:true})myStream.on('data',data=>yourLogicWith(data))Seven.listen(myStream)