Bump Version to 1.1.0

- adding support for customWriteStreams
- updating all used libraries to the latest version

README.md

@@ -5,13 +5,7 @@
 
 # zip-a-folder
 Easy to use zip (or tar) a complete folder plain into a zip file 
-including compression ratio handling.
-
-Version 1.0+ is incompatible to elder versions since it introduces a
-breaking API change. 
-* Callback function is NOT supported anymore. 
-* Provide the possibility to create tar archives. 
-* Set compression ratio (three levels supported by now uncompressed, medium and high)
+including compression ratio handling and custom write streams.
 
 ## Basic Usage
 
@@ -62,7 +56,30 @@ import { zip, COMPRESSION_LEVEL } from 'zip-a-folder';
 class TestMe {
 
     static async main() {
-        await zip('/path/to/the/folder', '/path/to/archive.zip', COMPRESSION_LEVEL.high);
+        await zip('/path/to/the/folder', '/path/to/archive.zip', {compression: COMPRESSION_LEVEL.high});
+    }
+}
+
+TestMe.main();
+```
+### Custom writeStreams
+You can now pipe output to any WriteStream (just pass WriteStream as a parameter).
+
+To keep the existing api stable the 2nd parameter (targetFilePath) can now be either undefined or 
+an empty string.
+
+ATTENTION: customWritestreams cannot be checked. So it is up to the user to check 
+on non existing target folders or if the targetfolder equals to the sourcefolder 
+(which leads to a circularity).
+
+```js
+import { zip, COMPRESSION_LEVEL } from 'zip-a-folder';
+import { fs } from 'fs';
+
+class TestMe {
+    static async main() {
+        const customWS = fs.createWriteStream('test/1234.zip');
+        await zipafolder.zip(path.resolve(__dirname, 'data/'), undefined, {customWriteStream: customWS});    
     }
 }
 

dist/lib/ZipAFolder.d.ts

@@ -1,11 +1,17 @@
+/// <reference types="node" />
+import { WriteStream } from 'fs';
 export declare enum COMPRESSION_LEVEL {
     uncompressed = 0,
     medium = 5,
     high = 9
 }
+export declare type ZipAFolderOptions = {
+    compression?: COMPRESSION_LEVEL;
+    customWriteStream?: WriteStream;
+};
 export declare class ZipAFolder {
-    static tar(srcFolder: string, zipFilePath: string, compression?: COMPRESSION_LEVEL): Promise<void | Error>;
-    static zip(srcFolder: string, zipFilePath: string, compression?: COMPRESSION_LEVEL): Promise<void | Error>;
+    static tar(srcFolder: string, tarFilePath: string | undefined, zipAFolderOptions?: ZipAFolderOptions): Promise<void | Error>;
+    static zip(srcFolder: string, zipFilePath: string | undefined, zipAFolderOptions?: ZipAFolderOptions): Promise<void | Error>;
     private static compress;
 }
 export declare const zip: typeof ZipAFolder.zip;