Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/webtorrent/webtorrent.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFeross Aboukhadijeh <feross@feross.org>2016-03-24 08:39:28 +0300
committerFeross Aboukhadijeh <feross@feross.org>2016-03-24 08:39:28 +0300
commitcc3d046f286377d2dd6df5d84e43594658bf8b32 (patch)
treeba8c5bf8dda8c0af9b97f262ac242f1b2adbe6d3 /docs/api.md
parentc5d508932d66abdb1827b0440403a9fcd001c67d (diff)
docs: add missing `torrent.uploaded`, `torrent.torrentFile`, `torrent.numPeers`
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md28
1 files changed, 20 insertions, 8 deletions
diff --git a/docs/api.md b/docs/api.md
index f10dcc5..3a06171 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -148,16 +148,20 @@ Aggregate "seed ratio" for all torrents (uploaded / downloaded), from 0 to 1.
## `torrent.infoHash`
-Get the info hash of the torrent.
+Info hash of the torrent (string).
## `torrent.magnetURI`
-Get the magnet URI of the torrent.
+Magnet URI of the torrent (string).
+
+## `torrent.torrentFile`
+
+`.torrent` file of the torrent (Buffer).
## `torrent.files[...]`
-An array of all files in the torrent. See the file section for more info on what methods
-the file has.
+Array of all files in the torrent. See documentation for `File` below to learn what
+methods/properties files have.
## `torrent.swarm`
@@ -165,15 +169,19 @@ The attached [bittorrent-swarm](https://github.com/feross/bittorrent-swarm) inst
## `torrent.received`
-Get total bytes received from peers (including invalid data).
+Total bytes received from peers (*including* invalid data).
## `torrent.downloaded`
-Get total bytes received from peers (excluding invalid data).
+Total *verified* bytes received from peers.
+
+## `torrent.uploaded`
+
+Total bytes uploaded to peers.
## `torrent.timeRemaining`
-Get the time remaining in millis if downloading.
+Time remaining for download to complete (in milliseconds).
## `torrent.downloadSpeed`
@@ -191,9 +199,13 @@ Torrent download progress, from 0 to 1.
Torrent "seed ratio" (uploaded / downloaded), from 0 to 1.
+## `torrent.numPeers`
+
+Number of peers in the torrent swarm.
+
## `torrent.path`
-Get the torrent download location.
+Torrent download location.
## `torrent.destroy()`