aminya / archive-files

Package for reading different archive files in a consistent way

Archive Files

Package for reading different archive files in a consistent way.

Overview

A consistent set of archive extractors, mainly those required to work with shockpkg packages, though other formats may be added.

Some functionality, like disk image reading, resource forks, and file permissions, can only be fully supported on certain platforms.

Currently supported archive files:

• ZIP (.zip)
• TAR (.tar)
• TAR gzip (.tar.gz, .tgz)
• TAR bzip2 (.tar.bz2, .tbz2)
• Disk Images (.dmg, .iso, .cdr), macOS only as it uses hdiutil

A plain directory can also be opened as an archive.

Usage

Basic Usage

Open a ZIP file

import {ArchiveZip} from '@shockpkg/archive-files';

const archive = new ArchiveZip('path/to/archive.zip');
await archive.read(async entry => {
	console.log(entry.path);
	await entry.extract(`extracted/${entry.path}`);
});

Open a file by file extension

import {createArchiveByFileExtension} from '@shockpkg/archive-files';

const archive = createArchiveByFileExtension('path/to/archive.zip');
await archive.read(async entry => {
	console.log(entry.path);
	await entry.extract(`extracted/${entry.path}`);
});

Bugs

If you find a bug or have compatibility issues, please open a ticket under issues section for this repository.

License

Copyright (c) 2019-2023 JrMasterModelBuilder

Licensed under the Mozilla Public License, v. 2.0.

If this license does not work for you, feel free to contact me.