diff options
author | Feross Aboukhadijeh <feross@feross.org> | 2016-03-04 01:24:44 +0300 |
---|---|---|
committer | Feross Aboukhadijeh <feross@feross.org> | 2016-03-04 01:24:44 +0300 |
commit | 6f2e85cd4649b3f1ddd67be9f4832c0138849b3e (patch) | |
tree | c4fe7a374bac9d62fad727e629b9143c453ac133 /README.md | |
parent | 2670b687f9ef7be87f4f8a128c80f0260f1ea131 (diff) |
documentation
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 21 insertions, 9 deletions
@@ -335,9 +335,21 @@ An array of all torrents in the client. Returns the torrent with the given `torrentId`. Convenience method. Easier than searching through the `client.torrents` array. Returns `null` if no matching torrent found. +#### `client.downloadSpeed` + +Total download speed for all torrents, in bytes/sec. + +#### `client.uploadSpeed` + +Total upload speed for all torrents, in bytes/sec. + +### `client.progress` + +Total download progress for all **active** torrents, from 0 to 1. + #### `client.ratio` -Seed ratio for all torrents in the client. +Aggregate "seed ratio" for all torrents (uploaded / downloaded), from 0 to 1. ### torrent api @@ -370,21 +382,21 @@ Get total bytes received from peers (excluding invalid data). Get the time remaining in millis if downloading. -#### `torrent.progress` +#### `torrent.downloadSpeed` -Get the total progress from 0 to 1. +Torrent download speed, in bytes/sec. -#### `torrent.ratio` +#### `torrent.uploadSpeed` -Get the torrent ratio (seeded/downloaded). +Torrent upload speed, in bytes/sec. -#### `torrent.downloadSpeed` +#### `torrent.progress` -Returns the download speed. +Torrent download progress, from 0 to 1. -#### `torrent.uploadSpeed` +#### `torrent.ratio` -Returns the current upload speed. +Torrent "seed ratio" (uploaded / downloaded), from 0 to 1. #### `torrent.path` |