diff options
| author | Feross Aboukhadijeh <feross@feross.org> | 2016-05-08 20:21:42 +0300 |
|---|---|---|
| committer | Feross Aboukhadijeh <feross@feross.org> | 2016-05-08 20:21:42 +0300 |
| commit | 47d181f809bf19b669c62457f7e8b45d72246b21 (patch) | |
| tree | 59c41144fb16a3b8560d5b88ff78ed32ee006509 /docs | |
| parent | 587f3adaf83c761c8cea30d62d3e68bc359ab31d (diff) | |
Move tracker options into `opts.tracker`
Closes #649
Based on a PR by @nkittsteiner. #791
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/api.md b/docs/api.md index a4ebe55..4750f02 100644 --- a/docs/api.md +++ b/docs/api.md @@ -51,16 +51,20 @@ If `opts` is specified, then the default options (shown below) will be overridde ```js { - dht: Boolean|Object, // Enable DHT (default=true), or options object for DHT - maxConns: Number, // Max number of connections per torrent (default=55) - nodeId: String|Buffer, // DHT protocol node ID (default=randomly generated) - peerId: String|Buffer, // Wire protocol peer ID (default=randomly generated) - rtcConfig: Object, // RTCPeerConnection configuration object (default=STUN only) - tracker: Boolean, // Whether or not to enable trackers (default=true) - wrtc: Object // Custom webrtc implementation (in node, specify the [wrtc](https://www.npmjs.com/package/wrtc) or [electron-webrtc](https://github.com/mappum/electron-webrtc) package) + dht: Boolean|Object, // Enable DHT (default=true), or options object for DHT + maxConns: Number, // Max number of connections per torrent (default=55) + nodeId: String|Buffer, // DHT protocol node ID (default=randomly generated) + peerId: String|Buffer, // Wire protocol peer ID (default=randomly generated) + tracker: Boolean|Object // Enable trackers (default=true), or options object for Tracker } ``` +For possible values of `opts.dht` see the +[`bittorrent-dht` documentation](https://github.com/feross/bittorrent-dht#dht--new-dhtopts). + +For possible values of `opts.tracker` see the +[`bittorrent-tracker` documentation](https://github.com/feross/bittorrent-tracker#client). + ## `client.add(torrentId, [opts], [function ontorrent (torrent) {}])` Start downloading a new torrent. |