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

API improve #750

Merged
merged 2 commits into from May 2, 2016
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

API improve

infohash, metadata and ready note. Added uploaded
  • Loading branch information
DiegoRBaquero committed Apr 12, 2016
commit 27691c9378e70bcf4cc06c123c0b93145447319d
@@ -334,21 +334,6 @@ listen to this event, but it may aid in debugging.
Emitted when the torrent encounters a fatal error. The torrent is automatically destroyed
and removed from the client when this occurs.

## `torrent.on('infoHash', function () {})`

Emitted when the info hash of the torrent has been determined.

## `torrent.on('metadata', function () {})`

Emitted when the metadata of the torrent has been determined. This includes the full
contents of the .torrent file, including list of files, torrent length, piece hashes,
piece length, etc.

## `torrent.on('ready', function () {})`

Emitted when the torrent is ready to be used (i.e. metadata is available and store is
ready).

## `torrent.on('done', function () {})`

Emitted when all the torrent files have been downloaded.
@@ -378,6 +363,20 @@ torrent.on('download', function(chunkSize){
})
```

## `torrent.on('upload', function (chunkSize) {})`

Emitted every time a new chunk of data is sent, it's useful for reporting the current torrent status, for instance:

```js
torrent.on('uploaded', function(chunkSize){
console.log('chunk size: ' + chunkSize);
console.log('total uploaded: ' + torrent.uploaded);
console.log('upload speed: ' + torrent.uploadSpeed);
console.log('progress: ' + torrent.progress);
console.log('======');
})
```

## `torrent.on('wire', function (wire) {})`

Emitted whenever a new peer is connected for this torrent. `wire` is an instance of
@@ -400,6 +399,21 @@ See the `bittorrent-protocol`
[extension api docs](https://github.com/feross/bittorrent-protocol#extension-api) for more
information on how to define a protocol extension.

## `torrent.on('infoHash', function () {})`

Emitted when the info hash of the torrent has been determined. Can only be accessed synchronously as client.add calls onTorrent callback after 'infoHash' event has been emitted.

This comment has been minimized.

Copy link
@feross

feross Apr 16, 2016

Member

I don't think we need the extra text. It makes it more confusing IMO. It's already clear from the fact that this is an event that it's async.


## `torrent.on('metadata', function () {})`

Emitted when the metadata of the torrent has been determined. This includes the full
contents of the .torrent file, including list of files, torrent length, piece hashes,
piece length, etc. Can only be accessed synchronously as client.add calls onTorrent callback after 'metadata' event has been emitted.

## `torrent.on('ready', function () {})`

Emitted when the torrent is ready to be used (i.e. metadata is available and store is
ready). Can only be accessed synchronously as client.add calls onTorrent callback after 'ready' event has been emitted.

# File API

## `file.name`
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.