Skip to content

Commit 6be0ece

Browse files
author
Kyle Jones
committed
added documentation
1 parent a2cae84 commit 6be0ece

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

index.d.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,13 @@ declare namespace JSZip {
9696
* The last modification date, defaults to the current date.
9797
*/
9898
date?: Date;
99+
/**
100+
* Sets per file compression. The `compressionOptions` parameter depends on the compression type.
101+
*/
99102
compression?: Compression;
103+
/**
104+
* 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)).
105+
*/
100106
compressionOptions?: null | {
101107
level: number;
102108
};
@@ -123,6 +129,9 @@ declare namespace JSZip {
123129

124130
interface JSZipGeneratorOptions<T extends OutputType = OutputType> {
125131
compression?: Compression;
132+
/**
133+
* 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)).
134+
*/
126135
compressionOptions?: null | {
127136
level: number;
128137
};

0 commit comments

Comments
 (0)