icsa v1.4.2

ICSA

ICSA is an archive file format based on brotli compression

Installation

npm install --save icsa

Examples

const {createICSAFile, createEICSAFile, writeICSAFile, writeEICSAFile, writeICSADir, readICSAFile, readEICSAFile} = require("icsa");

// Create File
let file = await createICSAFile("path/to/dir"); // => <Buffer ...> // Use await createEICSAFile("path/to/file.icsa", "32 key length") for create encrypted icsa;

// Write File
let write = await writeICSAFile("path/to/dir"[, "path/to/file.icsa"]); // => 'file "path/to/file.icsa" created' // Use await writeEICSAFile("path/to/file.icsa", "32 key length"[, "path/to/file.icsa"]) for write encrypted icsa;

// Read File
let icsa = await readICSAFile("path/to/file.icsa"); // Use await readEICSAFile("path/to/file.icsa", "32 key length") for read encrypted icsa

//Write Dir
let dir = await writeICSADir(/* ICSA class (see readICSAFile) */, "path/to/dir"); // => 'dir "path/to/dir" created'

/*
 * icsa.key => (only on readEICSAFile) The key you entered;
 * icsa.magic => Magic number "ICSA"
 * icsa.dir => All dirs and files:
 * {
 *   "/": {"file.ext": <Buffer ...>, ...},
 *   "/folder": {...}
 * }
 * icsa.error => "null" if there has been no errors
 */