@zip.js/zip.js 2.8.34 → 2.8.35

package/README.md

@@ -4,7 +4,7 @@ zip.js is a JavaScript open-source library (BSD-3-Clause license) for
 compressing and decompressing zip files. It has been designed to handle large amounts
 of data. It supports notably multi-core compression, native compression with
 compression streams, archives larger than 4GB with Zip64, split zip files, data
-encryption, and Deflate64 decompression.
+encryption, incremental writing, and Deflate64 decompression.
 
 # Demo
 
@@ -14,6 +14,18 @@ See https://gildas-lormeau.github.io/zip-manager
 
 See here for more info: https://gildas-lormeau.github.io/zip.js/
 
+# Bundle size
+
+zip.js is tree-shakeable: import named identifiers and your bundler removes what you do
+not use, e.g. the whole write path if you only read zip files. `import * as zip from
+"@zip.js/zip.js"` keeps everything.
+
+Smaller entry points are also available, e.g. `@zip.js/zip.js/lib/zip-core.js` embeds
+neither the Web Worker code nor the WASM module, pass `workerURI` and `wasmURI` to
+`configure()` instead. The prebuilt bundles in
+[`/dist`](https://github.com/gildas-lormeau/zip.js/tree/master/dist) are standalone files
+for script tags and AMD loaders, they are not tree-shaken.
+
 # Examples
 
 ## Hello world

package/deno.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zip-js/zip-js",
-	"version": "2.8.34",
+	"version": "2.8.35",
 	"exports": {
 		".": "./index.js"
 	},
@@ -16,10 +16,13 @@
 	},
 	"exclude": [
 		"rollup*",
+		"reserved-property-names.js",
+		"mangled-property-names.js",
 		"tsconfig.json",
 		".vscode",
 		".eslintrc.json",
 		"benchmarks",
-		"docs"
+		"docs",
+		".github"
 	]
 }

package/dist/README.md

@@ -2,6 +2,8 @@
 
 **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.
 
+**Note**: These bundles are standalone and always contain both `ZipReader` and `ZipWriter`, they are not tree-shaken. With a bundler, importing named identifiers from `index.js` already removes the direction you do not use.
+
 Contents:
 
 - `zip.js` / `zip.min.js`: Full `ZipWriter` / `ZipReader` bundles with embedded Web Worker code and WASM.
@@ -14,5 +16,5 @@ Online builder:
 Alternatively, you can build your own version of zip.js with the online builder, see https://gildas-lormeau.github.io/zip.js/builder.
 
 Notes:
-- Files suffixed with `-native` rely on a pure JavaScript implementation of Compression Streams instead of a WASM module.
+- Every bundle uses the native `CompressionStream`/`DecompressionStream` APIs when the environment supports them. What differs is the implementation embedded for everything else, i.e. custom compression levels, Deflate64 decompression, and environments lacking these APIs: a WASM module by default, or a pure JavaScript implementation of the Compression Streams API in the files suffixed with `-native`. The suffix names that implementation, it does not mean that these bundles rely more on the native APIs than the others.
 - `zip-legacy.min.js` is the equivalent of `zip.min.js` before the version `2.8`, it relies on a JavaScript implementation of Compression Streams (if used) but only in web workers. Alternatively `zip-native.min.js` includes the Compression Streams implementation in the main environment and the web workers.