Skip to content

Commit

Permalink
Require Node.js 18 and Electron 30 and move to ESM
Browse files Browse the repository at this point in the history
  • Loading branch information
@sindresorhus
sindresorhus committed May 1, 2024
1 parent d5a6db1 commit 6cf581f
Show file tree
Hide file tree
Showing 10 changed files with 294 additions and 310 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ jobs:
fail-fast: false
matrix:
node-version:
- 14
- 12
- 20
- 18
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
Expand Down
291 changes: 142 additions & 149 deletions index.d.ts
View file
Original file line number Diff line number Diff line change
@@ -1,191 +1,184 @@
import {BrowserView, BrowserWindow, DownloadItem, SaveDialogOptions} from 'electron';

declare namespace electronDl {
interface Progress {
percent: number;
transferredBytes: number;
totalBytes: number;
}
import {
type BrowserView,
type BrowserWindow,
type DownloadItem,
type SaveDialogOptions,
} from 'electron';

export type Progress = {
percent: number;
transferredBytes: number;
totalBytes: number;
};

interface File {
filename: string;
path: string;
fileSize: number;
mimeType: string;
url: string;
}
export type File = {
filename: string;
path: string;
fileSize: number;
mimeType: string;
url: string;
};

interface Options {
/**
Show a `Save As…` dialog instead of downloading immediately.
export type Options = {
/**
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.
Note: Only use this option when strictly necessary. Downloading directly without a prompt is a much better user experience.
@default false
*/
readonly saveAs?: boolean;
@default false
*/
readonly saveAs?: boolean;

/**
The directory to save the file in.
/**
The directory to save the file in.
Must be an absolute path.
Must be an absolute path.
Default: [User's downloads directory](https://electronjs.org/docs/api/app/#appgetpathname)
*/
readonly directory?: string;
Default: [User's downloads directory](https://electronjs.org/docs/api/app/#appgetpathname)
*/
readonly directory?: string;

/**
Name of the saved file.
This option only makes sense for `electronDl.download()`.
/**
Name of the saved file.
This option only makes sense for `electronDl.download()`.
Default: [`downloadItem.getFilename()`](https://electronjs.org/docs/api/download-item/#downloaditemgetfilename)
*/
readonly filename?: string;
Default: [`downloadItem.getFilename()`](https://electronjs.org/docs/api/download-item/#downloaditemgetfilename)
*/
readonly filename?: string;

/**
Title of the error dialog. Can be customized for localization.
/**
Title of the error dialog. Can be customized for localization.
Note: Error dialog will not be shown in `electronDl.download()`. Please handle error manually.
Note: Error dialog will not be shown in `electronDl.download()`. Please handle error manually.
@default 'Download Error'
*/
readonly errorTitle?: string;
@default 'Download Error'
*/
readonly errorTitle?: string;

/**
Message of the error dialog. `{filename}` is replaced with the name of the actual file. Can be customized for localization.
/**
Message of the error dialog. `{filename}` is replaced with the name of the actual file. Can be customized for localization.
Note: Error dialog will not be shown in `electronDl.download()`. Please handle error manually.
Note: Error dialog will not be shown in `electronDl.download()`. Please handle error manually.
@default 'The download of {filename} was interrupted'
*/
readonly errorMessage?: string;
@default 'The download of {filename} was interrupted'
*/
readonly errorMessage?: string;

/**
Optional callback that receives the [download item](https://electronjs.org/docs/api/download-item).
You can use this for advanced handling such as canceling the item like `item.cancel()`.
*/
readonly onStarted?: (item: DownloadItem) => void;
/**
Optional callback that receives the [download item](https://electronjs.org/docs/api/download-item).
You can use this for advanced handling such as canceling the item like `item.cancel()`.
*/
readonly onStarted?: (item: DownloadItem) => void;

/**
Optional callback that receives an object containing information about the progress of the current download item.
*/
readonly onProgress?: (progress: Progress) => void;
/**
Optional callback that receives an object containing information about the progress of the current download item.
*/
readonly onProgress?: (progress: Progress) => void;

/**
Optional callback that receives an object containing information about the combined progress of all download items done within any registered window.
/**
Optional callback that receives an object containing information about the combined progress of all download items done within any registered window.
Each time a new download is started, the next callback will include it. The progress percentage could therefore become smaller again.
This callback provides the same data that is used for the progress bar on the app icon.
*/
readonly onTotalProgress?: (progress: Progress) => void;
Each time a new download is started, the next callback will include it. The progress percentage could therefore become smaller again.
This callback provides the same data that is used for the progress bar on the app icon.
*/
readonly onTotalProgress?: (progress: Progress) => void;

/**
Optional callback that receives the [download item](https://electronjs.org/docs/api/download-item) for which the download has been cancelled.
*/
readonly onCancel?: (item: DownloadItem) => void;
/**
Optional callback that receives the [download item](https://electronjs.org/docs/api/download-item) for which the download has been cancelled.
*/
readonly onCancel?: (item: DownloadItem) => void;

/**
Optional callback that receives an object with information about an item that has been completed. It is called for each completed item.
*/
readonly onCompleted?: (file: File) => void;
/**
Optional callback that receives an object with information about an item that has been completed. It is called for each completed item.
*/
readonly onCompleted?: (file: File) => void;

/**
Reveal the downloaded file in the system file manager, and if possible, select the file.
/**
Reveal the downloaded file in the system file manager, and if possible, select the file.
@default false
*/
readonly openFolderWhenDone?: boolean;
@default false
*/
readonly openFolderWhenDone?: boolean;

/**
Show a file count badge on the macOS/Linux dock/taskbar icon when a download is in progress.
/**
Show a file count badge on the macOS/Linux dock/taskbar icon when a download is in progress.
@default true
*/
readonly showBadge?: boolean;
@default true
*/
readonly showBadge?: boolean;

/**
Show a progress bar on the dock/taskbar icon when a download is in progress.
/**
Show a progress bar on the dock/taskbar icon when a download is in progress.
@default true
*/
readonly showProgressBar?: boolean;
@default true
*/
readonly showProgressBar?: boolean;

/**
Allow downloaded files to overwrite files with the same name in the directory they are saved to.
/**
Allow downloaded files to overwrite files with the same name in the directory they are saved to.
The default behavior is to append a number to the filename.
The default behavior is to append a number to the filename.
@default false
*/
readonly overwrite?: boolean;
@default false
*/
readonly overwrite?: boolean;

/**
Customize the save dialog.
/**
Customize the save dialog.
If `defaultPath` is not explicity defined, a default value is assigned based on the file path.
If `defaultPath` is not explicity defined, a default value is assigned based on the file path.
@default {}
*/
readonly dialogOptions?: SaveDialogOptions;
}
}
@default {}
*/
readonly dialogOptions?: SaveDialogOptions;
};

/**
Error thrown if `item.cancel()` was called.
*/
declare class CancelError extends Error {}
export class CancelError extends Error {}

// eslint-disable-next-line no-redeclare
declare const electronDl: {
/**
Error thrown if `item.cancel()` was called.
*/
CancelError: typeof CancelError;

/**
Register the helper for all windows.
@example
```
import {app, BrowserWindow} from 'electron';
import electronDl = require('electron-dl');
/**
Register the helper for all windows.
electronDl();
@example
```
import {app, BrowserWindow} from 'electron';
import electronDl from 'electron-dl';
let win;
(async () => {
await app.whenReady();
win = new BrowserWindow();
})();
```
*/
(options?: electronDl.Options): void;
electronDl();
/**
This can be useful if you need download functionality in a reusable module.
@param window - Window to register the behavior on.
@param url - URL to download.
@returns A promise for the downloaded file.
@throws {CancelError} An error if the user calls `item.cancel()`.
@throws {Error} An error if the download fails.
@example
```
import {BrowserWindow, ipcMain} from 'electron';
import electronDl = require('electron-dl');
ipcMain.on('download-button', async (event, {url}) => {
const win = BrowserWindow.getFocusedWindow();
console.log(await electronDl.download(win, url));
});
```
*/
download(
window: BrowserWindow | BrowserView,
url: string,
options?: electronDl.Options
): Promise<DownloadItem>;
};
let mainWindow;
(async () => {
await app.whenReady();
mainWindow = new BrowserWindow();
})();
```
*/
export default function electronDl(options?: Options): void;

export = electronDl;
/**
This can be useful if you need download functionality in a reusable module.
@param window - Window to register the behavior on.
@param url - URL to download.
@returns A promise for the downloaded file.
@throws {CancelError} An error if the user calls `item.cancel()`.
@throws {Error} An error if the download fails.
@example
```
import {BrowserWindow, ipcMain} from 'electron';
import {download} from 'electron-dl';
ipcMain.on('download-button', async (event, {url}) => {
const win = BrowserWindow.getFocusedWindow();
console.log(await download(win, url));
});
```
*/
export function download(
window: BrowserWindow | BrowserView,
url: string,
options?: Options
): Promise<DownloadItem>;
Loading

0 comments on commit 6cf581f

Please sign in to comment.