sindresorhus/electron-dl

Enable an app to display a custom "interrupted" dialog

Open

#105 opened on Feb 13, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (1,206 stars) (136 forks)user submission
enhancementhelp wanted

Description

Rather than just allowing the 'The download of {filename} was interrupted' system message box text to be customized, enable the app to provide a dialog box styled per the app.

Could perhaps be achieved by one of: (a) Add an 'onError' optional callback. (No "interrupted" dialog is displayed is this callback is specified.) (b) Allow a blank string to be specified as the value of 'errorMessage'. (No "interrupted" dialog is displayed if the string is ""; the "interrupted" result can be found by testing the 'state' returned by the 'done' event).

Contributor guide

Tech stack
javascriptnodejs
Domain
desktop
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptElectron framework knowledgeUnderstanding of callbacks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the current implementation of download error handling in electron dl. Look at the codebase to understand how the app currently displays the 'interrupted' dialog. Consider implementing option (a): adding an optional 'onError' callback that overrides the default dialog. Alternatively, option (b): allowing an empty errorMessage string to suppress the dialog and let the app handle the state. Check existing tests and documentation for guidance. Discuss with maintainers if needed.