Merge pull request #852 from Stuk/metadata-ts

Stuk · web-flow · commit f299cce9b8d9 · 2022-07-21T11:28:32.000-07:00
Consolidate metadata types and expose OnUpdateCallback
diff --git a/index.d.ts b/index.d.ts
@@ -23,13 +23,6 @@ interface CompressionOptions {
     level: number;
 }
 
-interface Metadata  {
-    percent: number;
-    currentFile: string | null;
-}
-
-type OnUpdateCallback = (metadata: Metadata) => void;
-
 interface InputByType {
     base64: string;
     string: string;
@@ -71,6 +64,13 @@ declare namespace JSZip {
 
     type OutputType = keyof OutputByType;
 
+    interface JSZipMetadata {
+        percent: number;
+        currentFile: string | null;
+    }
+
+    type OnUpdateCallback = (metadata: JSZipMetadata) => void;
+
     interface JSZipObject {
         name: string;
         /**
@@ -170,11 +170,6 @@ declare namespace JSZip {
         decodeFileName?: (bytes: string[] | Uint8Array | Buffer) => string;
     }
 
-    interface JSZipMetadata {
-        percent: number;
-        currentFile: string;
-    }
-
     type DataEventCallback<T> = (dataChunk: T, metadata: JSZipMetadata) => void
     type EndEventCallback = () => void
     type ErrorEventCallback = (error: Error) => void
@@ -287,7 +282,7 @@ interface JSZip {
      * @param onUpdate The optional function called on each internal update with the metadata.
      * @return The serialized archive
      */
-    generateAsync<T extends JSZip.OutputType>(options?: JSZip.JSZipGeneratorOptions<T>, onUpdate?: OnUpdateCallback): Promise<OutputByType[T]>;
+    generateAsync<T extends JSZip.OutputType>(options?: JSZip.JSZipGeneratorOptions<T>, onUpdate?: JSZip.OnUpdateCallback): Promise<OutputByType[T]>;
 
     /**
      * Generates a new archive asynchronously
@@ -296,7 +291,7 @@ interface JSZip {
      * @param onUpdate The optional function called on each internal update with the metadata.
      * @return A Node.js `ReadableStream`
      */
-    generateNodeStream(options?: JSZip.JSZipGeneratorOptions<'nodebuffer'>, onUpdate?: OnUpdateCallback): NodeJS.ReadableStream;
+    generateNodeStream(options?: JSZip.JSZipGeneratorOptions<'nodebuffer'>, onUpdate?: JSZip.OnUpdateCallback): NodeJS.ReadableStream;
 
     /**
      * Generates the complete zip file with the internal stream implementation
