node-stream-zip - npm Package Compare versions

Comparing version 1.11.4 to 1.11.5

node_stream_zip.d.ts

 /// <reference types="node" />
 
-declare module 'node-stream-zip' {
+namespace StreamZip {
+    interface StreamZipOptions {
+        /**
+         * File to read
+         */
+        file: string
 
-    namespace StreamZip {
-        interface StreamZipOptions {
-            /**
-             * File to read
-             */
-            file: string
-    
-            /**
-             * You will be able to work with entries inside zip archive,
-             * otherwise the only way to access them is entry event
-             * @default true
-             */
-            storeEntries?: boolean
-    
-            /**
-             * By default, entry name is checked for malicious characters, like ../ or c:\123,
-             * pass this flag to disable validation error
-             * @default false
-             */
-            skipEntryNameValidation?: boolean
-    
-            /**
-             * Filesystem read chunk size
-             * @default automatic based on file size
-             */
-            chunkSize?: number
-        }
-    
-        interface ZipEntry {
-            /**
-             * file name
-             */
-            name: string
-    
-            /**
-             * true if it's a directory entry
-             */
-            isDirectory: boolean
-    
-            /**
-             * true if it's a file entry, see also isDirectory
-             */
-            isFile: boolean
-    
-            /**
-             * file comment
-             */
-            comment: string
-    
-            /**
-             * if the file is encrypted
-             */
-            encrypted: boolean
-    
-            /**
-             * version made by
-             */
-            verMade: number
-    
-            /**
-             * version needed to extract
-             */
-            version: number
-    
-            /**
-             * encrypt, decrypt flags
-             */
-            flags: number
-    
-            /**
-             * compression method
-             */
-            method: number
-    
-            /**
-             * modification time
-             */
-            time: number
-    
-            /**
-             * uncompressed file crc-32 value
-             */
-            crc: number
-    
-            /**
-             * compressed size
-             */
-            compressedSize: number
-    
-            /**
-             * uncompressed size
-             */
-            size: number
-    
-            /**
-             * volume number start
-             */
-            diskStart: number
-    
-            /**
-             * internal file attributes
-             */
-            inattr: number
-    
-            /**
-             * external file attributes
-             */
-            attr: number
-    
-            /**
-             * LOC header offset
-             */
-            offset: number
-        }
+        /**
+         * You will be able to work with entries inside zip archive,
+         * otherwise the only way to access them is entry event
+         * @default true
+         */
+        storeEntries?: boolean
+
+        /**
+         * By default, entry name is checked for malicious characters, like ../ or c:\123,
+         * pass this flag to disable validation error
+         * @default false
+         */
+        skipEntryNameValidation?: boolean
+
+        /**
+         * Filesystem read chunk size
+         * @default automatic based on file size
+         */
+        chunkSize?: number
     }
 
-    type StreamZipOptions = StreamZip.StreamZipOptions;
-    type ZipEntry = StreamZip.ZipEntry;
+    interface ZipEntry {
+        /**
+         * file name
+         */
+        name: string
 
-    class StreamZip {
-        constructor(config: StreamZipOptions);
+        /**
+         * true if it's a directory entry
+         */
+        isDirectory: boolean
 
         /**
-         * number of entries in the archive
+         * true if it's a file entry, see also isDirectory
          */
-        entriesCount: number
+        isFile: boolean
 
         /**
-         * archive comment
+         * file comment
          */
         comment: string
 
-        on(event: 'error', handler: (error: any) => void): void
-        on(event: 'entry', handler: (entry: ZipEntry) => void): void
-        on(event: 'ready', handler: () => void): void
-        on(event: 'extract', handler: (entry: ZipEntry, outPath: string) => void): void
+        /**
+         * if the file is encrypted
+         */
+        encrypted: boolean
 
-        entry(name: string): ZipEntry | undefined
+        /**
+         * version made by
+         */
+        verMade: number
 
-        entries(): { [name: string]: ZipEntry }
+        /**
+         * version needed to extract
+         */
+        version: number
 
-        stream(entry: string | ZipEntry, callback: (err: any | null, stream?: NodeJS.ReadableStream) => void): void
+        /**
+         * encrypt, decrypt flags
+         */
+        flags: number
 
-        entryDataSync(entry: string | ZipEntry): Buffer
+        /**
+         * compression method
+         */
+        method: number
 
-        openEntry(entry: string | ZipEntry, callback: (err: any | null, entry?: ZipEntry) => void, sync: boolean): void
+        /**
+         * modification time
+         */
+        time: number
 
-        extract(entry: string | ZipEntry | null, outPath: string, callback: (err?: any) => void): void
+        /**
+         * uncompressed file crc-32 value
+         */
+        crc: number
 
-        close(callback?: (err?: any) => void): void
+        /**
+         * compressed size
+         */
+        compressedSize: number
+
+        /**
+         * uncompressed size
+         */
+        size: number
+
+        /**
+         * volume number start
+         */
+        diskStart: number
+
+        /**
+         * internal file attributes
+         */
+        inattr: number
+
+        /**
+         * external file attributes
+         */
+        attr: number
+
+        /**
+         * LOC header offset
+         */
+        offset: number
     }
+}
 
-    export = StreamZip;
+type StreamZipOptions = StreamZip.StreamZipOptions;
+type ZipEntry = StreamZip.ZipEntry;
+
+class StreamZip {
+    constructor(config: StreamZipOptions);
+
+    /**
+     * number of entries in the archive
+     */
+    entriesCount: number
+
+    /**
+     * archive comment
+     */
+    comment: string
+
+    on(event: 'error', handler: (error: any) => void): void
+    on(event: 'entry', handler: (entry: ZipEntry) => void): void
+    on(event: 'ready', handler: () => void): void
+    on(event: 'extract', handler: (entry: ZipEntry, outPath: string) => void): void
+
+    entry(name: string): ZipEntry | undefined
+
+    entries(): { [name: string]: ZipEntry }
+
+    stream(entry: string | ZipEntry, callback: (err: any | null, stream?: NodeJS.ReadableStream) => void): void
+
+    entryDataSync(entry: string | ZipEntry): Buffer
+
+    openEntry(entry: string | ZipEntry, callback: (err: any | null, entry?: ZipEntry) => void, sync: boolean): void
+
+    extract(entry: string | ZipEntry | null, outPath: string, callback: (err?: any) => void): void
+
+    close(callback?: (err?: any) => void): void
 }
+
+export = StreamZip;

package.json

 {
   "name": "node-stream-zip",
-  "version": "1.11.4",
+  "version": "1.11.5",
   "description": "node.js library for reading and extraction of ZIP archives",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Worsened metrics

Total package byte prevSize

46696

decreased by-1.26%

Lines of code

1063

decreased by-0.19%

No dependency changes