The simple, all-in-one, JavaScript unarchiver that runs in your browser!
Supports .zip, .rar, .tar, .tar.gz, .tar.xz, and .tar.bz2 archive formats. Tested on Chrome, Firefox, Safari, and Edge.
<!-- Local (remember to extract all files) -->
<script src="./unarchiver.min.js"></script>
<!-- or Remote -->
<script src="https://xenova.github.io/unarchiver.js/dist/unarchiver.min.js"></script>// Load file (e.g., from URL or input element)
let file = new File(...);
// Open the file archive for reading
Unarchiver.open(file).then(async function (archive) {
for (let entry of archive.entries) {
if (entry.is_file) {
// File object for archive entry
let entry_file = await entry.read();
}
}
});Check out https://xenova.github.io/unarchiver.js/#demo for a demonstration of the library's functionality.
| Name | Description | Example |
|---|---|---|
Unarchiver.load(formats) |
Returns a Promise which will be fulfilled when the specified
formats have been loaded. format is an array of formats to be loaded,
selected from: zip, rar, tar,
gz, xz, and bz2. If no formats are provided,
all supported formats will be loaded.
Note: calling this method is optional since, by default, formats are loaded when they are needed for the first time. This method is used to speed up processing by preloading the necessary files. |
|
Unarchiver.open(file) |
Returns a Promise which will be fulfilled when the file has been
opened/unarchived. The fulfilled Promise contains the readable archive and holds the
following information:{
"file_name": String,
"archive_type": String,
"array_buffer": ArrayBuffer,
"entries": [object]
}
See below for how to read the archive entries.
|
|
Unarchiver.close(archive) |
Close an opened archive. Usually, this method is unnecessary, but may be useful if you wish to save memory. |
|
Each achive entry object contains the following attributes:
{
"name": String,
"is_file": Boolean,
"size_compressed": Integer,
"size_uncompressed": Integer
}
Additionally, an archive entry object contains a read() method which is used to read its data.
This method returns a Promise which will be fulfilled when the file has been loaded. The fulfilled Promise contains the File object of the entry. This means that regular File operations can be used to extract its data. For example:
Unarchiver.open(file).then(async function (archive) {
// Archive metadata
let archive_name = archive.file_name;
let archive_type = archive.archive_type;
for (let entry of archive.entries) {
// Entry's metadata
let name = entry.name;
let is_file = entry.is_file;
let size_compressed = entry.size_compressed;
let size_uncompressed = entry.size_uncompressed;
// Entry's data
if (is_file) {
// File object for archive entry
let entry_file = await entry.read();
// Actual data for archive entry
let entry_file_data = await entry_file.arrayBuffer();
// ... do something with entry_file and entry_file_data
console.log(entry_file, entry_file_data);
}
}
});let url = 'https://xenova.github.io/unarchiver.js/test_files/file.zip';
fetch(url).then(async function (data) {
// Load file from URL
let blob = await data.blob();
let file = new File([blob], url.split('/').pop(), { type: blob.type });
// Open the file archive
let archive = await Unarchiver.open(file);
for (let entry of archive.entries) {
if (entry.is_file) {
// File object for archive entry
let entry_file = await entry.read();
console.log(entry_file); // do something
}
}
});<input type="file" id="example-file">
<button onclick="readFile()">Read</button><br>
<div id="example-output"></div>
<script>
function readFile() {
let file = document.getElementById('example-file').files[0]
if (!file) return;
let output = document.getElementById('example-output');
// Open the file archive for reading
Unarchiver.open(file).then(async function (archive) {
output.innerHTML = '';
for (let entry of archive.entries) {
if (entry.is_file) {
output.innerHTML += entry.name + '<br>';
// File object for archive entry
// let entry_file = await entry.read();
}
}
});
}
</script>- Inspired by the Uncompress library by workhorsy
- Uses: