├── LICENSE.md
├── README.md
├── bower.json
├── download.js
├── download.min.js
└── package.json


/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2016 dandavis
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # download 
  2 | 
  3 | [![NPM version][npm-image]][npm-url] 
  4 | [![Size][size-image]][size-url] 
  5 | [![License][license-image]][license-url] 
  6 | [![CDNJS](https://img.shields.io/cdnjs/v/downloadjs.svg)](https://cdnjs.com/libraries/downloadjs)
  7 | 
  8 | 
  9 | ## Summary
 10 | ---------
 11 | The download() function is used to trigger a file download from JavaScript. 
 12 | 
 13 | It specifies the contents and name of a new file placed in the browser's download directory. The input can be a URL, String, Blob, or Typed Array of data, or via a dataURL representing the file's data as base64 or url-encoded string. No matter the input format, download() saves a file using the specified file name and mime information in the same manner as a server using a Content-Disposition HTTP header.
 14 | 
 15 | ## Getting and Using
 16 | ---------
 17 | 
 18 | ### Via NPM/Bower 
 19 | `npm install downloadjs`  <br />
 20 | `bower install downloadjs`
 21 | 
 22 | `require("downloadjs")(data, strFileName, strMimeType);`
 23 | 
 24 | ### Simple global `download` function via `<script>` include
 25 |     download(data, strFileName, strMimeType);
 26 | 
 27 | ### Included via AMD
 28 |     require(['path/to/file'], function(download) {
 29 |         download(data, strFileName, strMimeType);
 30 |     });
 31 | 
 32 | 
 33 | ### Parameters
 34 | ---------
 35 | * **data** - The Blob, File, String, or dataURL containing the soon-to-be File's contents.
 36 | * **strFileName** - The name of the file to be created. Note that older browsers (like FF3.5, Ch5) don't honor the file name you provide, instead they automatically name the downloaded file.
 37 | * **strMimeType** - The MIME content-type of the file to download. While optional, it helps the browser present friendlier information about the download to the user, encouraging them to accept the download.
 38 | 
 39 | 
 40 | 
 41 | ## Example Usage
 42 | ---------
 43 | 
 44 | 
 45 | ### Plain Text
 46 | #### text string  -  [live demo](http://pagedemos.com/hw24em95rsfq/output/)
 47 |     download("hello world", "dlText.txt", "text/plain");
 48 | 
 49 | #### text dataURL  -  [live demo](http://pagedemos.com/r9ywm98s6b29/output/)
 50 |     download("data:text/plain,hello%20world", "dlDataUrlText.txt", "text/plain");
 51 | 
 52 | #### text blob  -  [live demo](http://pagedemos.com/ckcah2vp8kza/output/)
 53 |     download(new Blob(["hello world"]), "dlTextBlob.txt", "text/plain");
 54 | 
 55 | #### text url - [live demo](http://pagedemos.com/pz6hkyqutjtw/output/)
 56 |     download("/robots.txt");
 57 | 
 58 | 
 59 | #### text UInt8 Array -  [live demo](http://pagedemos.com/zuyk46wbkktq/output/)
 60 |     var str= "hello world",	arr= new Uint8Array(str.length);
 61 |     str.split("").forEach(function(a,b){
 62 |    	  arr[b]=a.charCodeAt();
 63 |     });
 64 | 
 65 |     download( arr, "textUInt8Array.txt", "text/plain" );
 66 | 
 67 | ### HTML
 68 | #### html string -  [live demo](http://pagedemos.com/k7rwq7msu3eb/output/)
 69 |     download(document.documentElement.outerHTML, "dlHTML.html", "text/html");
 70 | 
 71 | #### html Blob -  [live demo](http://pagedemos.com/bxehm2fdf3g4/output/)
 72 |     download(new Blob(["hello world".bold()]), "dlHtmlBlob.html", "text/html");
 73 | 
 74 | #### ajax callback -  [live demo](http://pagedemos.com/arr2ym74aw8t/output/)
 75 | (note that callback mode won't work on vanilla ajax or with binary files)
 76 |    
 77 |     $.ajax({
 78 |     		url: "/download.html",
 79 |     		success: download.bind(true, "text/html", "dlAjaxCallback.html")
 80 |     });
 81 | 
 82 | 
 83 | ### Binary Files
 84 | #### image from URL  -  [live demo](http://pagedemos.com/yvvmxbjrwq7u/output/)
 85 |     download("/diff6.png");
 86 | 
 87 | #### Image via ajax for custom filename - [live demo](http://pagedemos.com/v2848zfgwrju/output/)
 88 | 	var x=new XMLHttpRequest();
 89 | 	x.open( "GET", "/diff6.png" , true);
 90 | 	x.responseType="blob";
 91 | 	x.onload= function(e){download(e.target.response, "awesomesauce.png", "image/png");};
 92 | 	x.send();
 93 | 
 94 | 
 95 | ## Compatibility
 96 | ---------
 97 | download.js works with a wide range of devices and browsers.
 98 | 
 99 | You can expect it to work for the vast majority of your users, with some common-sense limits:
100 | 
101 | * Devices without file systems like iPhone, iPad, Wii, et al. have nowhere to save the file to, sorry.
102 | * Android support starts at 4.2 for the built-in browser, though chrome 36+ and firefox 20+ on android 2.3+ work well.
103 | * Devices without Blob support won't be able to download Blobs or TypedArrays
104 | * Legacy devices (no a[download]) support can only download a few hundred kilobytes of data, and can't give the file a custom name.
105 | * Devices without window.URL support can only download a couple megabytes of data
106 | * IE versions of 9 and before are NOT supported because the don't support a[download] or dataURL frame locations.
107 | 
108 | 
109 | ## FAQ
110 | ---------
111 | 
112 |  * `Can I tell when a download is done/canceled?` No.
113 |  * `How can I style the temporary download link?` Define CSS class styles for `.download-js-link`.
114 |  * `What's up with Safari?` I don't know either but pull requests that improve the situation are welcome.
115 |  * `Why is my binary file corrupted?` Likely: an incorrect MIME or using jQuery ajax, which has no bin support.
116 |  * `How big of files work?` Depends, try yourself: [File Echo Demo](http://pagedemos.com/gqs6hbmjcpem/)... I do a 1GB dl routinely on a thinkpad...
117 | 
118 | 
119 | ## Change Log (v4.1)
120 | ---------
121 | * 2008 :: landed a FF+Chrome compatible way of downloading strings to local un-named files, upgraded to use a hidden frame and optional mime
122 | * 2012 :: added named files via a[download], msSaveBlob() for IE (10+) support, and window.URL support for larger+faster saves than dataURLs
123 | * 2014 :: added dataURL and Blob Input, bind-toggle arity, and legacy dataURL fallback was improved with force-download mime and base64 support
124 | * 2015 :: converted to amd/commonJS module with browser-friendly fallback
125 | * 2015 :: 4.1 added direct URL downloading via a single URL argument.
126 | * 2016 :: 4.2 added large dataURL support, a more semantic codebase, and hidden temp links
127 | * 2017 :: added support for empty dataURLs
128 | * 20XX :: ???? Considering Zip, Tar, and other multi-file outputs, Blob.prototype.download option, and more, stay tuned folks.
129 | 
130 | 
131 | [MIT license]: http://opensource.org/licenses/MIT
132 | [npm-image]: https://badge.fury.io/js/downloadjs.svg
133 | [npm-url]: https://npmjs.org/package/downloadjs
134 | [license-image]: https://img.shields.io/badge/license-MIT-green.svg
135 | [license-url]: http://opensource.org/licenses/MIT
136 | [size-image]: http://img.badgesize.io/rndme/download/master/download.min.js.svg?compression=gzip&label=gzip%20size
137 | [size-url]: https://unpkg.com/downloadjs
138 | 


--------------------------------------------------------------------------------
/bower.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "downloadjs",
 3 |   "main": "download.js",
 4 |   "homepage": "https://github.com/rndme/download",
 5 |   "description": "file downloading using client-side javascript",
 6 |   "moduleType": [
 7 |     "amd",
 8 |     "globals",
 9 |     "node"
10 |   ],
11 |   "license": "MIT",
12 |   "ignore": [
13 |     "**/.*",
14 |     "node_modules",
15 |     "bower_components",
16 |     "test",
17 |     "tests"
18 |   ]
19 | }
20 | 


--------------------------------------------------------------------------------
/download.js:
--------------------------------------------------------------------------------
  1 | //download.js v4.21, by dandavis; 2008-2018. [MIT] see http://danml.com/download.html for tests/usage
  2 | // v1 landed a FF+Chrome compatible way of downloading strings to local un-named files, upgraded to use a hidden frame and optional mime
  3 | // v2 added named files via a[download], msSaveBlob, IE (10+) support, and window.URL support for larger+faster saves than dataURLs
  4 | // v3 added dataURL and Blob Input, bind-toggle arity, and legacy dataURL fallback was improved with force-download mime and base64 support. 3.1 improved safari handling.
  5 | // v4 adds AMD/UMD, commonJS, and plain browser support
  6 | // v4.1 adds url download capability via solo URL argument (same domain/CORS only)
  7 | // v4.2 adds semantic variable names, long (over 2MB) dataURL support, and hidden by default temp anchors
  8 | // https://github.com/rndme/download
  9 | 
 10 | (function (root, factory) {
 11 | 	if (typeof define === 'function' && define.amd) {
 12 | 		// AMD. Register as an anonymous module.
 13 | 		define([], factory);
 14 | 	} else if (typeof exports === 'object') {
 15 | 		// Node. Does not work with strict CommonJS, but
 16 | 		// only CommonJS-like environments that support module.exports,
 17 | 		// like Node.
 18 | 		module.exports = factory();
 19 | 	} else {
 20 | 		// Browser globals (root is window)
 21 | 		root.download = factory();
 22 |   }
 23 | }(this, function () {
 24 | 
 25 | 	return function download(data, strFileName, strMimeType) {
 26 | 
 27 | 		var self = window, // this script is only for browsers anyway...
 28 | 			defaultMime = "application/octet-stream", // this default mime also triggers iframe downloads
 29 | 			mimeType = strMimeType || defaultMime,
 30 | 			payload = data,
 31 | 			url = !strFileName && !strMimeType && payload,
 32 | 			anchor = document.createElement("a"),
 33 | 			toString = function(a){return String(a);},
 34 | 			myBlob = (self.Blob || self.MozBlob || self.WebKitBlob || toString),
 35 | 			fileName = strFileName || "download",
 36 | 			blob,
 37 | 			reader;
 38 | 			myBlob= myBlob.call ? myBlob.bind(self) : Blob ;
 39 | 	  
 40 | 		if(String(this)==="true"){ //reverse arguments, allowing download.bind(true, "text/xml", "export.xml") to act as a callback
 41 | 			payload=[payload, mimeType];
 42 | 			mimeType=payload[0];
 43 | 			payload=payload[1];
 44 | 		}
 45 | 
 46 | 
 47 | 		if(url && url.length< 2048){ // if no filename and no mime, assume a url was passed as the only argument
 48 | 			fileName = url.split("/").pop().split("?")[0];
 49 | 			anchor.href = url; // assign href prop to temp anchor
 50 | 		  	if(anchor.href.indexOf(url) !== -1){ // if the browser determines that it's a potentially valid url path:
 51 |         		var ajax=new XMLHttpRequest();
 52 |         		ajax.open( "GET", url, true);
 53 |         		ajax.responseType = 'blob';
 54 |         		ajax.onload= function(e){ 
 55 | 				  download(e.target.response, fileName, defaultMime);
 56 | 				};
 57 |         		setTimeout(function(){ ajax.send();}, 0); // allows setting custom ajax headers using the return:
 58 | 			    return ajax;
 59 | 			} // end if valid url?
 60 | 		} // end if url?
 61 | 
 62 | 
 63 | 		//go ahead and download dataURLs right away
 64 | 		if(/^data:([\w+-]+\/[\w+.-]+)?[,;]/.test(payload)){
 65 | 		
 66 | 			if(payload.length > (1024*1024*1.999) && myBlob !== toString ){
 67 | 				payload=dataUrlToBlob(payload);
 68 | 				mimeType=payload.type || defaultMime;
 69 | 			}else{			
 70 | 				return navigator.msSaveBlob ?  // IE10 can't do a[download], only Blobs:
 71 | 					navigator.msSaveBlob(dataUrlToBlob(payload), fileName) :
 72 | 					saver(payload) ; // everyone else can save dataURLs un-processed
 73 | 			}
 74 | 			
 75 | 		}else{//not data url, is it a string with special needs?
 76 | 			if(/([\x80-\xff])/.test(payload)){			  
 77 | 				var i=0, tempUiArr= new Uint8Array(payload.length), mx=tempUiArr.length;
 78 | 				for(i;i<mx;++i) tempUiArr[i]= payload.charCodeAt(i);
 79 | 			 	payload=new myBlob([tempUiArr], {type: mimeType});
 80 | 			}		  
 81 | 		}
 82 | 		blob = payload instanceof myBlob ?
 83 | 			payload :
 84 | 			new myBlob([payload], {type: mimeType}) ;
 85 | 
 86 | 
 87 | 		function dataUrlToBlob(strUrl) {
 88 | 			var parts= strUrl.split(/[:;,]/),
 89 | 			type= parts[1],
 90 | 			indexDecoder = strUrl.indexOf("charset")>0 ? 3: 2,
 91 | 			decoder= parts[indexDecoder] == "base64" ? atob : decodeURIComponent,
 92 | 			binData= decoder( parts.pop() ),
 93 | 			mx= binData.length,
 94 | 			i= 0,
 95 | 			uiArr= new Uint8Array(mx);
 96 | 
 97 | 			for(i;i<mx;++i) uiArr[i]= binData.charCodeAt(i);
 98 | 
 99 | 			return new myBlob([uiArr], {type: type});
100 | 		 }
101 | 
102 | 		function saver(url, winMode){
103 | 
104 | 			if ('download' in anchor) { //html5 A[download]
105 | 				anchor.href = url;
106 | 				anchor.setAttribute("download", fileName);
107 | 				anchor.className = "download-js-link";
108 | 				anchor.innerHTML = "downloading...";
109 | 				anchor.style.display = "none";
110 |  				anchor.addEventListener('click', function(e) {
111 |  					e.stopPropagation();
112 |  					this.removeEventListener('click', arguments.callee);
113 |  				});
114 | 				document.body.appendChild(anchor);
115 | 				setTimeout(function() {
116 | 					anchor.click();
117 | 					document.body.removeChild(anchor);
118 | 					if(winMode===true){setTimeout(function(){ self.URL.revokeObjectURL(anchor.href);}, 250 );}
119 | 				}, 66);
120 | 				return true;
121 | 			}
122 | 
123 | 			// handle non-a[download] safari as best we can:
124 | 			if(/(Version)\/(\d+)\.(\d+)(?:\.(\d+))?.*Safari\//.test(navigator.userAgent)) {
125 | 				if(/^data:/.test(url))	url="data:"+url.replace(/^data:([\w\/\-\+]+)/, defaultMime);
126 | 				if(!window.open(url)){ // popup blocked, offer direct download:
127 | 					if(confirm("Displaying New Document\n\nUse Save As... to download, then click back to return to this page.")){ location.href=url; }
128 | 				}
129 | 				return true;
130 | 			}
131 | 
132 | 			//do iframe dataURL download (old ch+FF):
133 | 			var f = document.createElement("iframe");
134 | 			document.body.appendChild(f);
135 | 
136 | 			if(!winMode && /^data:/.test(url)){ // force a mime that will download:
137 | 				url="data:"+url.replace(/^data:([\w\/\-\+]+)/, defaultMime);
138 | 			}
139 | 			f.src=url;
140 | 			setTimeout(function(){ document.body.removeChild(f); }, 333);
141 | 
142 | 		}//end saver
143 | 
144 | 
145 | 
146 | 
147 | 		if (navigator.msSaveBlob) { // IE10+ : (has Blob, but not a[download] or URL)
148 | 			return navigator.msSaveBlob(blob, fileName);
149 | 		}
150 | 
151 | 		if(self.URL){ // simple fast and modern way using Blob and URL:
152 | 			saver(self.URL.createObjectURL(blob), true);
153 | 		}else{
154 | 			// handle non-Blob()+non-URL browsers:
155 | 			if(typeof blob === "string" || blob.constructor===toString ){
156 | 				try{
157 | 					return saver( "data:" +  mimeType   + ";base64,"  +  self.btoa(blob)  );
158 | 				}catch(y){
159 | 					return saver( "data:" +  mimeType   + "," + encodeURIComponent(blob)  );
160 | 				}
161 | 			}
162 | 
163 | 			// Blob but not URL support:
164 | 			reader=new FileReader();
165 | 			reader.onload=function(e){
166 | 				saver(this.result);
167 | 			};
168 | 			reader.readAsDataURL(blob);
169 | 		}
170 | 		return true;
171 | 	}; /* end download() */
172 | }));
173 | 


--------------------------------------------------------------------------------
/download.min.js:
--------------------------------------------------------------------------------
1 | //download.js v4.21, by dandavis; 2008-2018. [MIT] see http://danml.com/download.html for tests/usage
2 | ;(function(root,factory){typeof define=="function"&&define.amd?define([],factory):typeof exports=="object"?module.exports=factory():root.download=factory()})(this,function(){return function download(data,strFileName,strMimeType){var self=window,defaultMime="application/octet-stream",mimeType=strMimeType||defaultMime,payload=data,url=!strFileName&&!strMimeType&&payload,anchor=document.createElement("a"),toString=function(a){return String(a)},myBlob=self.Blob||self.MozBlob||self.WebKitBlob||toString,fileName=strFileName||"download",blob,reader;myBlob=myBlob.call?myBlob.bind(self):Blob,String(this)==="true"&&(payload=[payload,mimeType],mimeType=payload[0],payload=payload[1]);if(url&&url.length<2048){fileName=url.split("/").pop().split("?")[0],anchor.href=url;if(anchor.href.indexOf(url)!==-1){var ajax=new XMLHttpRequest;return ajax.open("GET",url,!0),ajax.responseType="blob",ajax.onload=function(e){download(e.target.response,fileName,defaultMime)},setTimeout(function(){ajax.send()},0),ajax}}if(/^data:([\w+-]+\/[\w+.-]+)?[,;]/.test(payload)){if(!(payload.length>2096103.424&&myBlob!==toString))return navigator.msSaveBlob?navigator.msSaveBlob(dataUrlToBlob(payload),fileName):saver(payload);payload=dataUrlToBlob(payload),mimeType=payload.type||defaultMime}else if(/([\x80-\xff])/.test(payload)){var i=0,tempUiArr=new Uint8Array(payload.length),mx=tempUiArr.length;for(i;i<mx;++i)tempUiArr[i]=payload.charCodeAt(i);payload=new myBlob([tempUiArr],{type:mimeType})}blob=payload instanceof myBlob?payload:new myBlob([payload],{type:mimeType});function dataUrlToBlob(strUrl){var parts=strUrl.split(/[:;,]/),type=parts[1],indexDecoder=strUrl.indexOf("charset")>0?3:2,decoder=parts[indexDecoder]=="base64"?atob:decodeURIComponent,binData=decoder(parts.pop()),mx=binData.length,i=0,uiArr=new Uint8Array(mx);for(i;i<mx;++i)uiArr[i]=binData.charCodeAt(i);return new myBlob([uiArr],{type:type})}function saver(url,winMode){if("download"in anchor)return anchor.href=url,anchor.setAttribute("download",fileName),anchor.className="download-js-link",anchor.innerHTML="downloading...",anchor.style.display="none",anchor.addEventListener("click",function(e){e.stopPropagation(),this.removeEventListener("click",arguments.callee)}),document.body.appendChild(anchor),setTimeout(function(){anchor.click(),document.body.removeChild(anchor),winMode===!0&&setTimeout(function(){self.URL.revokeObjectURL(anchor.href)},250)},66),!0;if(/(Version)\/(\d+)\.(\d+)(?:\.(\d+))?.*Safari\//.test(navigator.userAgent))return/^data:/.test(url)&&(url="data:"+url.replace(/^data:([\w\/\-\+]+)/,defaultMime)),window.open(url)||confirm("Displaying New Document\n\nUse Save As... to download, then click back to return to this page.")&&(location.href=url),!0;var f=document.createElement("iframe");document.body.appendChild(f),!winMode&&/^data:/.test(url)&&(url="data:"+url.replace(/^data:([\w\/\-\+]+)/,defaultMime)),f.src=url,setTimeout(function(){document.body.removeChild(f)},333)}if(navigator.msSaveBlob)return navigator.msSaveBlob(blob,fileName);if(self.URL)saver(self.URL.createObjectURL(blob),!0);else{if(typeof blob=="string"||blob.constructor===toString)try{return saver("data:"+mimeType+";base64,"+self.btoa(blob))}catch(y){return saver("data:"+mimeType+","+encodeURIComponent(blob))}reader=new FileReader,reader.onload=function(e){saver(this.result)},reader.readAsDataURL(blob)}return!0}});
3 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "downloadjs",
 3 |   "main": "download.js",
 4 |   "version": "1.4.8",
 5 |   "description": "file downloading using client-side javascript",
 6 |   "keywords": [
 7 |     "files",
 8 |     "dataURL",
 9 |     "blob",
10 |     "download"
11 |   ],
12 |   "homepage": "http://danml.com/download.html",
13 |   "license": "MIT",
14 |   "author": {
15 |     "name": "dandavis",
16 |     "email": "rndme@users.noreply.github.com",
17 |     "url": "http://danml.com/"
18 |   },
19 |   "repository": {
20 |     "type": "git",
21 |     "url": "https://github.com/rndme/download.git"
22 |   },
23 |   "bugs": {
24 |     "email": "rndme@users.noreply.github.com"
25 |   },
26 |   "files": [
27 |     "download.js",
28 |     "download.min.js"
29 |   ],
30 |   "npmName": "downloadjs",
31 |   "npmFileMap": [
32 |     {
33 |       "basePath": "/",
34 |       "files": [
35 |         "*.js"
36 |       ]
37 |     }
38 |   ]
39 | }
40 | 


--------------------------------------------------------------------------------