0.1.0 • Published 3 years ago

unpack-all v0.1.0

Weekly downloads
13
License
MIT
Repository
-
Last release
3 years ago

unpack-all

Wrapper for unar and lsar command line tool. It allows you to unpack a lot of formats: zip, zipx, rar, 7z, tar, gzip, bzip2, lzma, ... complete list

Installation

Installation avaiable for Mac OS X, Windows, Ubuntu and other Linuxes: see here. Window users can use a 'portable' version of Unarchiver: just copy the three files Foundation.1.0.dll, unar.exe and lsar.exe to the root of your node app.

Usage

import { list as unpckList } from 'unpack-all';
import { unpack as unpck } from 'unpack-all';
import { unpackSync } from 'unpack-all';

// list only:
unpckList(archiveFile<String>, options<Object>, callback<function>);
// or list sync:
const res = await unpackAll.listSync(archiveFile<String>, options<Object>);

// unpack:
unpck(archiveFile<String>, options<Object>, callback<function>);
// or unpack sync:
const files = await unpackSync(archiveFile<String>, options<Object>);

Examples

Example: unpack file

import { unpack as unpck } from 'unpack-all';

unpck(
    'test/abc.rar', 
    { 
      targetDir: 'out' 
    }, 
    (err, files, text) => {
       if (err) return console.error(err);
       if (files) console.log('files', files);
       if (text) console.log('text', text);
    });

Example: list content

import { list as unpckList } from 'unpack-all';

function cb(err, files, text) {
    if (err) return console.error(err);
    console.log('files', files);
}

unpckList('test/abc.rar', {}, cb);

Options

KeyPossible valuesComment
quiettrue/false (default)true will reduce logging for unpacking
targetDir\The directory to write the contents of the archive to. Defaults to the current directory.
randomTargetSubDirtrue/false (default)If true, a random subfolder will created for each unpack operation in target dir.
forceOverwritetrue/false (default)if null, tmp dir will created automatically
forceDirectorytrue/false/undefinedAlways create a containing directory for the contents of the unpacked archive. By default, a directory is created if there is more than one top-level file or folder.
noDirectorytrue/false/undefinedNever create a containing directory for the contents of the unpacked archive.
noRecursiontrue/false/undefinedDo not attempt to extract archives contained in other archives. For instance, when unpacking a .tar.gz file, only unpack the .gz file and not its contents.
copyTimetrue/false/undefinedCopy the file modification time from the archive file to the containing directory, if one is created.
password\The password to use for decrypting protected archives.
passwordEncoding\The encoding to use for the password for the archive, when it is not known. If not specified, then either the encoding given by the -encoding option or the auto-detected encoding is used.
encoding\The encoding to use for filenames in the archive, when it is not known. If not specified, the program attempts to auto-detect the encoding used. Use "help" or "list" as the argument to give
0.1.0

3 years ago

0.0.24

3 years ago

0.0.21

3 years ago

0.0.22

3 years ago

0.0.23

3 years ago

0.0.20

4 years ago

0.0.10

4 years ago

0.0.11

4 years ago

0.0.13

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

9 years ago

0.0.3

9 years ago

0.0.2

9 years ago

0.0.1

9 years ago