Skip to content

/ webtorrent

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

Jump to bottom

Missing torrent API #1705

Closed
gjuchault opened this issue Aug 14, 2019 · 3 comments · Fixed by #1708
Closed

Missing torrent API #1705

gjuchault opened this issue Aug 14, 2019 · 3 comments · Fixed by #1708
Labels
area/docs enhancement

Comments

@gjuchault
Copy link
Contributor

@gjuchault gjuchault commented Aug 14, 2019

What version of this package are you using?

N/A

What operating system, Node.js, and npm version?

N/A

What happened?

Some keys are missing in the torrent documentation (readme):

  1. announce
  2. maxWebConns
  3. ready, destroyed, paused, done
  4. pieces (and the Piece documentation)
  5. created, createdBy, comment
  6. length, pieceLength, lastPieceLength

What did you expect to happen?

N/A

Are you willing to submit a pull request to fix this bug?

Yes
@gjuchault gjuchault mentioned this issue Aug 14, 2019
Merged
9 of 9 tasks complete
@feross

This comment has been minimized.

Sign in to view
Copy link
Member

@feross feross commented Aug 14, 2019

Hi @gjuchault, thanks for the issue. We'd be happy to accept a PR to add these missing properties to the documentation!

Many of these properties come from the output of parse-torrent. You can refer to that documentation to make sure you get them all. I would skip the two letter properties that come from magnet links as those are not included if Torrent was initialized from a .torrent file instead of a magnet link.

Cheers!
@gjuchault

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

@gjuchault gjuchault commented Aug 15, 2019

@feross Which keys are not included in a .torrent file ? It seems that pieceLength and lastPieceLength are included (which makes sense)
@gjuchault gjuchault mentioned this issue Aug 15, 2019
Merged
@feross feross closed this in #1708 Aug 15, 2019
@feross

This comment has been minimized.

Sign in to view
Copy link
Member

@feross feross commented Aug 15, 2019

Yep, those two are included.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs enhancement
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

docs(api): add documentation for some properties
2 participants
@gjuchault @feross
You can’t perform that action at this time.