|
1 | | -# Built scripts of zip.js |
| 1 | +# Prebuilt zip.js bundles |
2 | 2 |
|
3 | | -**Warning**: These files are not compatible with ES modules, i.e. they cannot be imported with `import`. Instead, import `index.js` in the root folder of the project or one of the files prefixed with `zip-` in the [`/lib`](../lib) folder (e.g. `/lib/zip-no-worker-inflate.js`). |
| 3 | +**Note**: These bundles are not ES module compatible (you cannot `import` them directly). Use `index.js` at the project root or one of the `zip-*.js` files in [`/lib`](../lib) (e.g. `/lib/zip-core.js`) for ESM usage. |
4 | 4 |
|
5 | | -- for production (minified): |
| 5 | +Contents: |
6 | 6 |
|
7 | | -| | [`ZipReader`](https://gildas-lormeau.github.io/zip.js/api/classes/ZipReader.html) API | [`ZipWriter`](https://gildas-lormeau.github.io/zip.js/api/classes/ZipWriter.html) API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/api/classes/FS.html) API | Web Workers | No Web Workers | Usage | |
8 | | -|--------------------------------|-----------------|-----------------|--------------|-------------|----------------|-------------------------------------------------------| |
9 | | -| `zip.min.js` | x | x | | x | | compression/decompression with web workers | |
10 | | -| `zip-no-worker.min.js` | x | x | | | x | compression/decompression without web workers | |
11 | | -| `zip-no-worker-inflate.min.js` | x | | | | x | decompression without web workers | |
12 | | -| `zip-no-worker-deflate.min.js` | | x | | | x | compression without web workers | |
13 | | -| `zip-full.min.js` | x | x | | x | x | compression/decompression with or without web workers | |
14 | | -| `zip-fs.min.js` | x | x | x | x | | compression/decompression with web workers | |
15 | | -| `zip-fs-full.min.js` | x | x | x | x | x | compression/decompression with or without web workers | |
16 | | - |
17 | | -- for development/debugging: |
18 | | - |
19 | | -| | `zip` API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/api/classes/FS.html) API | Web Workers | No Web Workers | |
20 | | -|-----------------------|-----------|--------------|-------------|----------------| |
21 | | -| `zip.js` | x | | x | | |
22 | | -| `zip-full.js` | x | | x | x | |
23 | | -| `zip-fs.js` | x | x | x | | |
24 | | -| `zip-fs-full.js` | x | x | x | x | |
25 | | - |
26 | | -- `z-worker.js` can be used as a web worker script if the [Content Security Policy](https://developer.mozilla.org/docs/Web/HTTP/CSP) blocks scripts loaded with a `blob:` scheme |
27 | | -- `z-worker-fflate.js` is the web worker script for using [fflate](https://gildas-lormeau.github.io/zip.js/core-api.html#alternative-codec-fflate) |
28 | | -- `z-worker-pako.js` is the web worker script for using [pako](https://gildas-lormeau.github.io/zip.js/core-api.html#alternative-codec-pako) |
| 7 | +- `zip.js` / `zip.min.js`: Full `ZipWriter` / `ZipReader` bundles with embedded Web Worker code and WASM. |
| 8 | +- `zip-fs.js` / `zip-fs.min.js`: Full `ZipWriter` / `ZipReader` plus virtual file system (`fs`), with embedded Web Worker code and WASM. |
| 9 | +- `zip-core.js` / `zip-core.min.js`: Minimal `ZipWriter` / `ZipReader`. |
| 10 | +- `zip-fs-core.js` / `zip-fs-core.min.js`: Minimal `ZipWriter` / `ZipReader` plus virtual file system (`fs`). |
0 commit comments