esm-archive v0.0.8

esm-archive

Bundle multiple files into a single binary blob.

import { Archive, bundle } from "esm-archive";

// bundle some files
const data = bundle([
  new File(["bar"], "foo.txt", { type: "text/plain" }),
  new File(["foo"], "bar.txt", { type: "text/plain" }),
]);

// use the archive
const archive = new Archive(data);
archive.checksum; // a 32-bit checksum of the archive
archive.entries.length; // => 2
archive.entries[0].name; // => "foo.txt"
archive.entries[0].type; // => "text/plain"
archive.entries[1].name; // => "bar.txt"
archive.entries[1].type; // => "text/plain"
archive.openFile("foo.txt"); // => File(["bar"], "foo.txt", { type: "text/plain" })
archive.openFile("bar.txt"); // => File(["foo"], "bar.txt", { type: "text/plain" })

Compression

This library does not compress the archived files. Here is an example of how to use CompressionStream to compress data using gzip, and DecompressionStream to decompress it again.

import { Archive, bundle } from "esm-archive";

// compress the archive using CompressionStream
const data = bundle([/* ... */]);
const compressed = await readAll(new Blob([data]).stream().pipeThrough(new CompressionStream("gzip")));

// use the compressed archive
const decompressed = await readAll(new Blob([compressed]).stream().pipeThrough(new DecompressionStream("gzip")));
const archive = new Archive(decompressed);

Note that CompressionStream and DecompressionStream are not supported in all browsers, and you may need to use a polyfill or a different compression algorithm depending on your requirements.