Provide access to receivedBytes and totalBytes

[davej]

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.

[sindresorhus]

Sure. Let's just make it a breaking change and include the percentage in the object too and make it the first argument.

Pull request welcome :)

[davej]

Cool. Yes to eta and bps too?

[sindresorhus]

Yes, but with more verbose names.

[davej]

Ok, might make the download stats stuff a separate module and reuse that. Sound ok?

[sindresorhus]

Sure

[davej]

Started on this and created a lib for it: https://github.com/DaveJ/transfer-stats
Should the onProgress arg be a Set containing all transfers?

Any thoughts on testing this within the context of electron-dl?

[sindresorhus]

Should the onProgress arg be a Set containing all transfers?

For electronDl([options]) yes, but for electronDl.download(window, url, [options]) it should just be that specific transfer.

Any thoughts on testing this within the context of electron-dl?

You could do mostly something like this test:

electron-dl/test/index.js

Line 25 in c7cf282

test('Download a single file', async t => {

[davej]

Thanks. The problem I've found with that test is that updated only seems to get called once (when progress is at 0 bytes). Perhaps that's OK and we can rely on manual testing to make sure progress works? transfer-stats is pretty well tested.

[sindresorhus]

@davej Yeah, that should be fine.