Merge pull request #21 from kozakdenys/feature/possibility-to-change-…

…filename

Add posibility to change downloaded file name

README.md

@@ -118,11 +118,18 @@ Param  |Type  |Description
 -------|------|--------------------------------------
 options|object|The same options as for initialization
 
-`QRCodeStyling.download(extension) => void`
+`QRCodeStyling.download(downloadOptions) => void`
 
-Param    |Type                          |Default Value
----------|------------------------------|-------------
-extension|string (`'png' 'jpeg' 'webp'`)|`'png'`
+Param          |Type  |Description
+---------------|------|------------
+downloadOptions|object|Options with extension and name of file (not required)
+
+`downloadOptions` structure
+
+Property |Type                          |Default Value|Description
+---------|------------------------------|-------------|-----------------------------------------------------
+name     |string                        |`'qr'`       |Name of the downloaded file
+extension|string (`'png' 'jpeg' 'webp'`)|`'png'`      |File extension
 
 ### License
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "qr-code-styling",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Add a style and an image to your QR code",
   "main": "lib/qr-code-styling.js",
   "files": [

src/core/QRCodeStyling.ts

@@ -5,6 +5,11 @@ import QRCanvas from "./QRCanvas";
 import defaultOptions, { Options } from "./QROptions";
 import qrcode from "qrcode-generator";
 
+type DownloadOptions = {
+  name?: string;
+  extension?: Extension;
+};
+
 export default class QRCodeStyling {
   _options: Options;
   _container?: HTMLElement;
@@ -55,14 +60,32 @@ export default class QRCodeStyling {
     this._container = container;
   }
 
-  download(extension?: Extension): void {
+  download(downloadOptions?: Partial<DownloadOptions> | string): void {
     if (!this._drawingPromise) return;
 
     this._drawingPromise.then(() => {
       if (!this._canvas) return;
 
-      const data = this._canvas.getCanvas().toDataURL(extension ? `image/${extension}` : undefined);
-      downloadURI(data, `qr.${extension || "png"}`);
+      let extension = "png";
+      let name = "qr";
+
+      //TODO remove deprecated code in the v2
+      if (typeof downloadOptions === "string") {
+        extension = downloadOptions;
+        console.warn(
+          "Extension is deprecated as argument for 'download' method, please pass object { name: '...', extension: '...' } as argument"
+        );
+      } else if (typeof downloadOptions === "object" && downloadOptions !== null) {
+        if (downloadOptions.name) {
+          name = downloadOptions.name;
+        }
+        if (downloadOptions.extension) {
+          extension = downloadOptions.extension;
+        }
+      }
+
+      const data = this._canvas.getCanvas().toDataURL(`image/${extension}`);
+      downloadURI(data, `${name}.${extension}`);
     });
   }
 }