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>2017-04-15 00:34:02 +0300
committerFeross Aboukhadijeh <feross@feross.org>2017-04-15 00:34:02 +0300
commitb4e79a368d60b5bea9d705676ee76e6f9d7c0a4e (patch)
tree1b20c7f9c6aefc059e67f6dc93d36fb02929447b /docs/api.md
parenteb6c827cdee108c7f3983eda2c2a43ac5cd0a2d9 (diff)
feross -> webtorrent
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/api.md b/docs/api.md
index 70046e4..e6805b6 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -63,10 +63,10 @@ If `opts` is specified, then the default options (shown below) will be overridde
```
For possible values of `opts.dht` see the
-[`bittorrent-dht` documentation](https://github.com/feross/bittorrent-dht#dht--new-dhtopts).
+[`bittorrent-dht` documentation](https://github.com/webtorrent/bittorrent-dht#dht--new-dhtopts).
For possible values of `opts.tracker` see the
-[`bittorrent-tracker` documentation](https://github.com/feross/bittorrent-tracker#client).
+[`bittorrent-tracker` documentation](https://github.com/webtorrent/bittorrent-tracker#client).
## `client.add(torrentId, [opts], [function ontorrent (torrent) {}])`
@@ -77,7 +77,7 @@ Start downloading a new torrent.
- magnet uri (string)
- torrent file (buffer)
- info hash (hex string or buffer)
-- parsed torrent (from [parse-torrent](https://github.com/feross/parse-torrent))
+- parsed torrent (from [parse-torrent](https://github.com/webtorrent/parse-torrent))
- http/https url to a torrent file (string)
- filesystem path to a torrent file (string) *(Node.js only)*
@@ -125,7 +125,7 @@ Or, an **array of `string`, `File`, `Buffer`, or `stream.Readable` objects**.
If `opts` is specified, it should contain the following types of options:
-- options for [create-torrent](https://github.com/feross/create-torrent#createtorrentinput-opts-function-callback-err-torrent-) (to allow configuration of the .torrent file that is created)
+- options for [create-torrent](https://github.com/webtorrent/create-torrent#createtorrentinput-opts-function-callback-err-torrent-) (to allow configuration of the .torrent file that is created)
- options for `client.add` (see above)
If `onseed` is specified, it will be called when the client has begun seeding the file.
@@ -428,9 +428,9 @@ Emitted whenever data is uploaded. Useful for reporting the current torrent stat
## `torrent.on('wire', function (wire) {})`
Emitted whenever a new peer is connected for this torrent. `wire` is an instance of
-[`bittorrent-protocol`](https://github.com/feross/bittorrent-protocol), which is a
+[`bittorrent-protocol`](https://github.com/webtorrent/bittorrent-protocol), which is a
node.js-style duplex stream to the remote peer. This event can be used to specify
-[custom BitTorrent protocol extensions](https://github.com/feross/bittorrent-protocol#extension-api).
+[custom BitTorrent protocol extensions](https://github.com/webtorrent/bittorrent-protocol#extension-api).
Here is a usage example:
@@ -444,7 +444,7 @@ torrent1.on('wire', function (wire, addr) {
```
See the `bittorrent-protocol`
-[extension api docs](https://github.com/feross/bittorrent-protocol#extension-api) for more
+[extension api docs](https://github.com/webtorrent/bittorrent-protocol#extension-api) for more
information on how to define a protocol extension.
## `torrent.on('noPeers', function (announceType) {})`
@@ -479,7 +479,7 @@ Useful if you know you need the file at a later stage.
Deselects the file, which means it won't be downloaded unless someone creates a stream
for it.
-*Note: This method is currently not working as expected, see [dcposch answer on #164](https://github.com/feross/webtorrent/issues/164) for a nice work around solution.
+*Note: This method is currently not working as expected, see [dcposch answer on #164](https://github.com/webtorrent/webtorrent/issues/164) for a nice work around solution.
## `stream = file.createReadStream([opts])`