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

docs(api): add documentation for some properties #1708

Merged
merged 2 commits into from Aug 15, 2019

Conversation

@gjuchault
Copy link
Contributor

gjuchault commented Aug 15, 2019

Added announce, maxWebConns, ready, paused, done, pieces, created, createdBy, comment, length, pieceLength and lastPieceLength.

Closes #1705

@welcome

This comment has been minimized.

Copy link

welcome bot commented Aug 15, 2019

🙌 Thanks for opening this pull request! You're awesome.

@gjuchault gjuchault force-pushed the gjuchault:add-torrent-properties branch from 13ab30a to deb7391 Aug 15, 2019
…, done, pieces, created, createdBy, comment, lenght, pieceLength and lastPieceLength
@gjuchault gjuchault force-pushed the gjuchault:add-torrent-properties branch from deb7391 to f008b63 Aug 15, 2019
@feross
feross approved these changes Aug 15, 2019
Copy link
Member

feross left a comment

I fixed up the issues I noted

docs/api.md Outdated

Sum of the files length (in bytes).

## `torrent.pieceLength`

This comment has been minimized.

Copy link
@feross

feross Aug 15, 2019

Member

This is duplicated

docs/api.md Outdated

Length in bytes of all the pieces but the last one.

## `torrent.lastPieceLength`

This comment has been minimized.

Copy link
@feross

feross Aug 15, 2019

Member

So is this

@feross feross merged commit f4a82af into webtorrent:master Aug 15, 2019
1 of 3 checks passed
1 of 3 checks passed
continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
LGTM analysis: JavaScript No code changes detected
Details
@welcome

This comment has been minimized.

Copy link

welcome bot commented Aug 15, 2019

🎉 Congrats on getting your first pull request landed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

2 participants
You can’t perform that action at this time.