guilmour 4d48d7b520 Version 0.1 | 6 tahun lalu | |
---|---|---|
.. | ||
index.js | 6 tahun lalu | |
license | 6 tahun lalu | |
readme.md | 6 tahun lalu |
Simplified file downloads for your Electron app
$ npm install electron-dl
This is probably what you want for your app.
const {app, BrowserWindow} = require('electron');
require('electron-dl')();
let win;
app.on('ready', () => {
win = new BrowserWindow();
});
This can be useful if you need download functionality in a reusable module.
const {app, BrowserWindow, ipcMain} = require('electron');
const {download} = require('electron-dl');
ipcMain.on('download-btn', (e, args) => {
download(BrowserWindow.getFocusedWindow(), args.url)
.then(dl => console.log(dl.getSavePath()))
.catch(console.error);
});
It can only be used in the main process.
Type: BrowserWindow
Window to register the behavior on.
Type: string
URL to download.
Type: boolean
Default: false
Show a Save As…
dialog instead of downloading immediately.
Note: Only use this option when strictly necessary. Downloading directly without a prompt is a much better user experience.
Type: string
Default: User's downloads directory
Directory to save the file in.
Type: string
Default: downloadItem.getFilename()
Name of the saved file.
This option only makes sense for electronDl.download()
.
Type: string
Default: Download Error
Title of the error dialog. Can be customized for localization.
Type: string
Default: The download of {filename} was interrupted
Message of the error dialog. {filename}
is replaced with the name of the actual file. Can be customized for localization.
Type: Function
Optional callback that receives the download item.
You can use this for advanced handling such as canceling the item like item.cancel()
.
Type: Function
Optional callback that receives a number between 0
and 1
representing the progress of the current download.
Type: Function
Optional callback that receives the downloadItem for which the download has been cancelled.
Type: boolean
Default: false
Reveal the downloaded file in the system file manager, and if possible, select the file.
Type: boolean
Default: true
Shows the file count badge on macOS/Linux dock icons when download is in progress.
After making changes, run the automated tests:
$ npm test
And before submitting a pull request, run the manual tests to manually verify that everything works:
npm start
MIT © Sindre Sorhus