Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs to several unlisted functions #542

Merged
merged 2 commits into from Dec 28, 2015
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

Next

Add docs to several unlisted functions

+ made lack of UDP/TCP support more obvious.
  • Loading branch information
vinz243 committed Dec 28, 2015
commit 3ddc4317baf8985782398ab5f5c893ae3ec5dcea
@@ -20,7 +20,7 @@ other torrent clients.

In the browser, WebTorrent uses **WebRTC** (data channels) for peer-to-peer transport.
It can be used **without** browser plugins, extensions, or installations. It's Just
JavaScript™.
JavaScript™. Note: WebTorrent does **not** support UDP/TCP peers in browser.

Simply include the
[`webtorrent.min.js`](https://cdn.jsdelivr.net/webtorrent/latest/webtorrent.min.js) script
@@ -316,7 +316,6 @@ through the `client.torrents` array. Returns `null` if no matching torrent found

Seed ratio for all torrents in the client.


### torrent api

#### `torrent.infoHash`
@@ -344,6 +343,27 @@ Get total bytes received from peers (including invalid data)

Get total bytes received from peers (excluding invalid data)

#### `torrent.timeRemaining`

Get the time remaining in millis if downloading

### `torrent.progress`

Get the total progress from 0 to 1.

### `torrent.ratio`

Get the torrent ratio (seeded/downloaded)

### `torrent.downloadSpeed()`

Returns the download speed

### `torrent.uploadSpeed()`

Returns the current upload speed.


#### `torrent.path`

Get the torrent download location
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.