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

Missing API documentation for "torrent.on" #740

Closed
Tercus opened this issue Apr 8, 2016 · 5 comments
Closed

Missing API documentation for "torrent.on" #740

Tercus opened this issue Apr 8, 2016 · 5 comments

Comments

@Tercus
Copy link
Contributor

@Tercus Tercus commented Apr 8, 2016

  • WebTorrent version: 0.86.2
  • Node.js version: 5.8.0

The API documentation does not list all the possible triggers that can be used for "torrent.on". It would be really helpful if there was a complete list of them. These are the ones I found being used in webtorrent-desktop:

    torrent.on('warning', function (err) {})
    torrent.on('error', function (err) {})
    torrent.on('infoHash', function () {})
    torrent.on('metadata', function () {})
    torrent.on('ready', function () {})
    torrent.on('done', function () {})

After all, they are great for debugging.

@rom1504

This comment has been minimized.

Copy link
Member

@rom1504 rom1504 commented Apr 8, 2016

a few are there https://github.com/feross/webtorrent/blob/master/docs/api.md#torrentondone-function-- but I guess the other ones might be documented yeah

@DiegoRBaquero

This comment has been minimized.

Copy link
Member

@DiegoRBaquero DiegoRBaquero commented Apr 10, 2016

Feel free to throw make a PR :)

@Tercus

This comment has been minimized.

Copy link
Contributor Author

@Tercus Tercus commented Apr 11, 2016

I'm new to using github, so I think I have done that?
#747

I only added minimal info, because I don't really know much about them. But often it helps just knowing that the options are there...

@feross

This comment has been minimized.

Copy link
Member

@feross feross commented Apr 11, 2016

Done, thanks!

@feross feross closed this Apr 11, 2016
@lock

This comment has been minimized.

Copy link

@lock lock bot commented May 4, 2018

This thread has been automatically locked because it has not had recent activity. To discuss futher, please open a new issue.

@lock lock bot locked as resolved and limited conversation to collaborators May 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.