pull request #4 merges
TEMPORARY: Just to use a fix before
JS File Downloader
Introduction
JS File Downloader is a simple no dependency library you will be able to download file from browser and show downloading status.
Browser Compatibility
JS File Downloader supports all browsers that are ES5-compliant (IE8 and below are not supported).
Installing with package manager
With a package manager (recomanded):
npm install js-file-downloader --save
Basic usage
; const fileUrl = 'http://...'; url: fileUrl ;
Use without a package manager
Download this library from https://github.com/AleeeKoi/js-file-downloader/releases
<script src="/path/to/js-file-downloader.min.js"></script><script> // Then somewhere in your code url: 'http://alessandropellizzari.it/assets/img/og-image.jpg' ;</script>
Options:
process (for checking download status)
A function to call every time a process event is called. Function receive an Event Object as input.
{ if !eventlengthComputable return; // guard var downloadingPercentage = Math; // what to do ...}; url: '...' process: process
headers (of request)
If you need to customize request header data you can pass an array of objects like following example:
url: '...' headers: name: 'Authorization' value: 'Bearer ABC123...'
filename
Setting this String you can force output file name
mobileDisabled
Boolean value (default false) to enable/disable library on mobile browsers.
timeout (ms)
Integer value (default 40000) defining how much ms attend before stop download action.
autoStart
Boolean value (default true) to enable/disable automatically starting the download. When the value is true
the constructor returns a Promise
, however when it's set to false, the constructor doesn't return anything and the download can be started by calling the start()
method on the object.
Example with autoStart
set to true
url: '...' autoStart: true
Example with autoStart
set to false
const download = url: '...' autoStart: false; downloadstart ;
forceDesktopMode
Boolean value (default false) to force desktop mode even on mobile devices for downloading files.
url: '...' forceDesktopMode: true
License
Copyright (c) 2019-present, Alessandro Pellizzari