Simplified file downloads for your Electron app
JavaScript
Latest commit 6637ef0 Jan 10, 2017 @sindresorhus 1.6.0
Permalink
Failed to load latest commit information.
.editorconfig meta tweaks May 12, 2016
.gitattributes init Nov 18, 2015
.gitignore init Nov 18, 2015
.travis.yml meta tweaks May 12, 2016
index.js New options for localization and callbacks (#11) Jan 10, 2017
license init Nov 18, 2015
package.json 1.6.0 Jan 10, 2017
readme.md New options for localization and callbacks (#11) Jan 10, 2017
screenshot.png init Nov 18, 2015
test.js tweaks Dec 1, 2015

readme.md

electron-dl Build Status

Simplified file downloads for your Electron app

Why?

  • One function call instead of having to manually implement a lot of boilerplate.
  • Saves the file to the users Downloads directory instead of prompting.
  • Bounces the Downloads directory in the dock when done. (macOS)
  • Shows download progress. Example on macOS:

Install

$ npm install --save electron-dl

Usage

Register it for all windows

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();
});

Use it manually

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);
});

API

electronDl([options])

electronDl.download(window, url, [options]): Promise<DownloadItem>

window

Type: BrowserWindow

Window to register the behavior on.

url

Type: string

URL to download.

options

saveAs

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.

directory

Type: string
Default: User's downloads directory

Directory to save the file in.

errorTitle

Type: string
Default: Download Error

Title of the error dialog. Can be customized for localization.

errorMessage

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.

onProgress

Type: Function

Optional callback that receives a number between 0 and 1 representing the progress of the current download.

Related

License

MIT © Sindre Sorhus