An archiving library designed for delivering files to the browser in bulk.
Want to see pretty graphs? Log in now!
npm install quickarchive
|5||downloads in the last week|
|8||downloads in the last month|
|Last Published By|
|Version||1.0.2 last updated 4 months ago|
|Keywords||archive, html5, game, zip|
This is a file archiving library designed to be as simple, fast and space efficient as possible. It's intended use is in transferring assets in web applications and runs on node.js an the browsers. It does not use compression.
Because if you have a web application with a large number of files that you need to load, it can be much quicker to load a single archive file than to load each file individually.
Compression is not included because most browsers and server support compression on the fly.
First, create a new archive.
var myArchive = new QuickArchive(); //with optional comments myArchive.comment("An archive file.");
Next, add some data to it.
//Data can be a string... myArchive.addData("entry a", "Hello World"); //Or a buffer on node, or a ArrayBuffer or ArrayBufferView on browsers myArchive.addData("entry b", new Buffer([1, 2, 3])); //Also has optional comments myArchive.addData("entry c", "This will be converted to binary data", "This is a text comment.");
toBuffer() and do whatever you want with it.
//Returns a Buffer on Node and a Uint8Array on browsers var buffer = myArchive.toBuffer();
To load files, pass a Buffer or ArrayBuffer or ArrayBufferView to the constructor.
//Copy the archive var anotherArchive = new QuickArchive(buffer);