From a2cae846722538c8d0cc58ed3e091e27052b846b Mon Sep 17 00:00:00 2001 From: Kyle Jones Date: Thu, 29 Oct 2020 13:46:27 -0500 Subject: [PATCH 1/3] updated compression typings for JSZipFileOptions --- index.d.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/index.d.ts b/index.d.ts index d3531b51..36db9b9f 100644 --- a/index.d.ts +++ b/index.d.ts @@ -96,7 +96,10 @@ declare namespace JSZip { * The last modification date, defaults to the current date. */ date?: Date; - compression?: string; + compression?: Compression; + compressionOptions?: null | { + level: number; + }; comment?: string; /** Set to `true` if (and only if) the input is a "binary string" and has already been prepared with a `0xFF` mask. */ optimizedBinaryString?: boolean; From 6be0ecececcf5556a9ab91e7d606e5486dbd4f74 Mon Sep 17 00:00:00 2001 From: Kyle Jones Date: Thu, 29 Oct 2020 13:52:22 -0500 Subject: [PATCH 2/3] added documentation --- index.d.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/index.d.ts b/index.d.ts index 36db9b9f..5f973de3 100644 --- a/index.d.ts +++ b/index.d.ts @@ -96,7 +96,13 @@ declare namespace JSZip { * The last modification date, defaults to the current date. */ date?: Date; + /** + * Sets per file compression. The `compressionOptions` parameter depends on the compression type. + */ compression?: Compression; + /** + * Sets per file compression level. With `STORE` (no compression), this parameter is ignored. With `DEFLATE`, you can give the compression level with `compressionOptions : {level:6}` (or any level between 1 (best speed) and 9 (best compression)). + */ compressionOptions?: null | { level: number; }; @@ -123,6 +129,9 @@ declare namespace JSZip { interface JSZipGeneratorOptions { compression?: Compression; + /** + * The `compressionOptions` parameter depends on the compression type. With `STORE` (no compression), this parameter is ignored. With `DEFLATE`, you can give the compression level with `compressionOptions : {level:6}` (or any level between 1 (best speed) and 9 (best compression)). + */ compressionOptions?: null | { level: number; }; From c3f10e7c36b7cae5f2ecd4d91db186eea8d23cd2 Mon Sep 17 00:00:00 2001 From: Kyle Jones Date: Thu, 29 Oct 2020 13:54:44 -0500 Subject: [PATCH 3/3] added documentation --- index.d.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/index.d.ts b/index.d.ts index 5f973de3..121ec2f6 100644 --- a/index.d.ts +++ b/index.d.ts @@ -128,6 +128,9 @@ declare namespace JSZip { } interface JSZipGeneratorOptions { + /** + * Sets compression option for all entries that have not specified their own `compression` option + */ compression?: Compression; /** * The `compressionOptions` parameter depends on the compression type. With `STORE` (no compression), this parameter is ignored. With `DEFLATE`, you can give the compression level with `compressionOptions : {level:6}` (or any level between 1 (best speed) and 9 (best compression)).