Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
feross committed Mar 3, 2016
1 parent 2670b68 commit 6f2e85c
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 6f2e85c

Please sign in to comment.