ZipWriter
Encodes a filemap into a Zip Archive. Returns an ArrayBuffer that is a valid Zip Archive and can be written to file.
| Loader | Characteristic |
|---|---|
| File Extension | .zip |
| File Type | Binary |
| Data Format | "File Map" |
| File Format | ZIP Archive |
| Encoder Type | Asynchronous |
| Worker Thread | No |
| Streaming | No |
Usage
import {encode, writeFile} from '@loaders.gl/core';
import {ZipWriter} from '@loaders.gl/zip';
const FILEMAP = {
filename1: arrayBuffer1,
'directory/filename2': ...
};
const arrayBuffer = await encode(FILE_MAP, ZipWriter)
writeFile(zipFileName, arrayBuffer);
File Format
The file map is an object with keys representing file names or relative paths in the zip file, and values being the contents of each sub file (either ArrayBuffer or String).
Options
Options are forwarded to JSZip.generateAsync, however type is always set to arraybuffer to ensure compatibility with writer driver functions in @loaders.gl/core.