sindresorhus/electron-dl

Provide access to receivedBytes and totalBytes

Open

#31 opened on Oct 27, 2017

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

Description

Perhaps in the onProgress handler? It could receive a second parameter with a details object. The signature could look something like this:

{
  receivedBytes,
  totalBytes,
  item,
}

Further expanding on this idea, it could also include useful info like eta (estimated time remaining in milliseconds) and bps (current bytes per second). These would be handy but are less important as they can be calculated outside of the module using receivedBytes, totalBytes and a setTimeout.

Contributor guide

Tech stack
javascriptelectron
Domain
api
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
JavaScriptElectron basicsUnderstanding of download events
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the current `onProgress` handler implementation in the source code (likely `index.js`). Review the Electron documentation for the 'will download' event and the `DownloadItem` object to understand available properties like `receivedBytes` and `totalBytes`. Look at issue comments for any discussion about the proposed signature. Check if there are any linked PRs or branches that attempt this feature. Ensure the new parameter object is consistent with the library's existing API style and does not break existing usage.
Provide access to receivedBytes and totalBytes · sindresorhus/electron-dl#31 | Good First Issue