@zip.js/zip.js 2.7.42 → 2.7.44

package/index.d.ts

@@ -629,15 +629,21 @@ export class Uint8ArrayWriter extends Writer<Uint8Array> { }
  * Represents an instance used to create an unzipped stream.
  *
  * @example
- * This example will take a zip file, decompress it and then recompress each file in it, saving it to disk.
+ * This example will take a zip file, decompress it and then save its files and directories to disk.
  * ```
- * for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipWriterStream()))
- *   if (entry.readable) {
- *     console.log(entry.filename)
- *     entry.readable
- *       .pipeThrough(ZipReaderStream().transform(entry.filename))
- *       .pipeTo((await Deno.create(entry.filename + '.zip')).writable)
+ * import {resolve} from "https://deno.land/std/path/mod.ts";
+ * import {ensureDir, ensureFile} from "https://deno.land/std/fs/mod.ts";
+ *
+ * for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipReaderStream())) {
+ *   const fullPath = resolve(destination, entry.filename);
+ *   if (entry.directory) {
+ *     await ensureDir(fullPath);
+ *     continue;
  *   }
+ *
+ *   await ensureFile(fullPath);
+ *   await entry.readable?.pipeTo((await Deno.create(fullPath)).writable);
+ * }
  * ```
  */
 export class ZipReaderStream<T> {
@@ -786,9 +792,9 @@ export interface GetEntriesOptions {
    * 
    * @param value The raw text value.
    * @param encoding The encoding of the text.
-   * @returns The decoded text value.
+   * @returns The decoded text value or `undefined` if the raw text value should be decoded by zip.js.
    */
-  decodeText?(value: Uint8Array, encoding: string): string
+  decodeText?(value: Uint8Array, encoding: string): string | undefined;
 }
 
 /**
@@ -1235,7 +1241,7 @@ export interface ZipWriterConstructorOptions {
   /**
    * `true` to keep the order of the entry physically in the zip file.
    *
-   * When set to `true`, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the `zip54` option to `true` explicitly.
+   * When set to `true`, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the `zip64` option to `true` explicitly.
    * Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.
    *
    * @defaultValue true
@@ -1355,9 +1361,9 @@ export interface ZipWriterConstructorOptions {
    * Encode the filename and the comment of the entry.
    * 
    * @param text The text to encode.
-   * @returns The encoded text.
+   * @returns The encoded text or `undefined` if the text should be encoded by zip.js.
    */
-  encodeText?(text: string): Uint8Array
+  encodeText?(text: string): Uint8Array | undefined;
 }
 
 /**
@@ -1960,10 +1966,6 @@ export const ERR_BAD_FORMAT: string;
  * End of Central Directory Record not found error
  */
 export const ERR_EOCDR_NOT_FOUND: string;
-/**
- * Zip64 End of Central Directory Record not found error
- */
-export const ERR_EOCDR_ZIP64_NOT_FOUND: string;
 /**
  * Zip64 End of Central Directory Locator not found error
  */

package/index.js

@@ -63,7 +63,6 @@ export {
 	ERR_HTTP_RANGE,
 	ERR_BAD_FORMAT,
 	ERR_EOCDR_NOT_FOUND,
-	ERR_EOCDR_ZIP64_NOT_FOUND,
 	ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND,
 	ERR_CENTRAL_DIRECTORY_NOT_FOUND,
 	ERR_LOCAL_FILE_HEADER_NOT_FOUND,