mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

feat: add getUploadProgress API to the net API (#13783)

Browse source
This commit is contained in:
Samuel Attard 2018-07-28 00:15:48 +10:00 • committed by Charles Kerr
parent c8dc2d3730
commit 4b3011f3e8
6 changed files with 45 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/api/client-request.md
View file

@ -215,3 +215,17 @@ response object,it will emit the `aborted` event.
#### `request.followRedirect()`
Continues any deferred redirection request when the redirection mode is `manual`.
#### `request.getUploadProgress()`
Returns `Object`:
* `active` Boolean - Whether the request is currently active. If this is false
no other properties will be set
* `started` Boolean - Whether the upload has started. If this is false both
`current` and `total` will be set to 0.
* `current` Integer - The number of bytes that have been uploaded so far
* `total` Integer - The number of bytes that will be uploaded this request
You can use this method in conjunction with `POST` requests to get the progress
of a file upload or other data transfer.