Skip to content

Update index.d.ts to loosen type restriction on download #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Salketer wants to merge 1 commit into from
Closed

Update index.d.ts to loosen type restriction on download #172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
type BrowserWindow,
type DownloadItem,
type SaveDialogOptions,
type WebContents,
} from 'electron';

export type Progress = {
Expand Down Expand Up @@ -178,7 +179,7 @@
```
*/
export function download(
window: BrowserWindow | BrowserView,
window: { webContents: Electron.WebContents },

Check failure on line 182 in index.d.ts

View workflow job for this annotation

GitHub Actions / Node.js 20 

There should be no space after '{'.

Check failure on line 182 in index.d.ts

View workflow job for this annotation

GitHub Actions / Node.js 20 

There should be no space before '}'.

Check failure on line 182 in index.d.ts

View workflow job for this annotation

GitHub Actions / Node.js 18 

There should be no space after '{'.

Check failure on line 182 in index.d.ts

View workflow job for this annotation

GitHub Actions / Node.js 18 

There should be no space before '}'.
Copy link
Owner

@sindresorhus sindresorhus Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has the downside of not making it clear to the user what they can pass in. Autocomplete is more important than flexibility here I think. So I prefer to just list the supported types.

url: string,
options?: Options
): Promise<DownloadItem>;
Loading