github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-11 00:18:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: specify string values for DownloadItem

Browse Source 
Explicitly list the possible string return values for the updated and done events so that the typescript declaration file can model them more accurately. At present they are represented as a string type.

Fixes : https://github.com/electron/electron-typescript-definitions/issues/71
This commit is contained in:
TechnicalSoup
2017-12-14 08:16:20 +11:00
parent 249bd41e11
commit 0ea296b1cb
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/download-item.md
View File

@@ -44,7 +44,7 @@ win.webContents.session.on('will-download', (event, item, webContents) => {
Returns:
* `event` Event
* `state` String
* `state` String - Can be `progressing` or `interrupted`.
Emitted when the download has been updated and is not done.
@@ -58,7 +58,7 @@ The `state` can be one of following:
Returns:
* `event` Event
* `state` String
* `state` String - Can be `completed`, `cancelled` or `interrupted`.
Emitted when the download is in a terminal state. This includes a completed
download, a cancelled download (via `downloadItem.cancel()`), and interrupted