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
path: root/docs/api.md
AgeCommit message (Collapse)Author
2022-02-17chore(docs): Remove duplicate config row (#2265)Artak Safaryan
2022-02-04fix: getStreamURL docs (#2257)Cas
2021-12-08Added missing comma from api.md (#2231)developomp
2021-10-25fix: add storeOpts, specify store path, align with docs (#2121)Cas
* fix: add storeOpts, specify store path, align with docs * make changes non-breaking by default * debatable documentation update * add torrent name to store name * reduce hash name * Update lib/torrent.js * fix filegetmodtimes * bump fs chunk store Co-authored-by: Diego Rodríguez Baquero <github@diegorbaquero.com>
2021-08-20docs: document SW renderer (#2174)Cas
2021-07-25fix: log error when failing to load blocklist ip setDiego Rodríguez Baquero
2021-07-24feat: add speed limit to client (#2062)Alex
* Add speed limit to client * Fix standard * Update docs/api.md * Add changes from PR feedback Co-authored-by: Kadu Diógenes <kadu@fnix.com.br> Co-authored-by: Ivan Gorbanev <ivang@van.work> Co-authored-by: ultimate-tester <jordimueters@hotmail.com> Co-authored-by: Julen Garcia Leunda <hicom150@gmail.com> Co-authored-by: Niklas Johansson <niklas.y.johansson@se.abb.com> Co-authored-by: ThaUnknown <kapi.skowronek@gmail.com> Co-authored-by: Diego Rodríguez Baquero <github@diegorbaquero.com>
2021-07-03docs: update docs (#2124)Cas
Co-authored-by: Diego Rodríguez Baquero <github@diegorbaquero.com>
2021-07-03docs: no more var (#2123)Diego Rodríguez Baquero
* docs: no more var * Update api.md * remove var * remove var
2021-06-30feat: Use a cache on the chunk store (#2095)John Hiesey
2021-06-30docs: update utp defaultDiego Rodríguez Baquero
2021-03-25Add opts.destroyStoreOnDestroy to torrentJohn Hiesey
2021-02-27Code review fixesJohn Hiesey
2020-11-13oxford commaFeross Aboukhadijeh
2020-11-12Document lsd optionJulen Garcia Leunda
2020-10-27docsFeross Aboukhadijeh
2020-10-02Add uTP support (BEP29)Julen Garcia Leunda
2020-09-10Merge pull request #1364 from KayleePop/destroyKaylee
2020-05-05added more explicit docs for certian key items (relevent github issue ↵Aditya Shankar
https://github.com/webtorrent/webtorrent/issues/1846)
2020-04-15Docs and tests for store destructionKaylee
2020-03-15Add tests for private optionAlex
2020-03-14Add private attribute to docsAlex
2019-08-15doc: Remove duplicated API docsFeross Aboukhadijeh
2019-08-15docs(api): add documentation for announce, maxWebConns, ready, paused, done, ↵Gabriel Juchault
pieces, created, createdBy, comment, lenght, pieceLength and lastPieceLength
2019-07-23doc: add torrent.nameFeross Aboukhadijeh
2019-07-09Add torrent.rescanFiles() to allow manual verifyJohn Hiesey
Useful if files are modified externally to webtorrent.
2018-04-20Update documentation for render-media@3Feross Aboukhadijeh
2018-04-01Remove semicolons for consistencyRaymond Tan
2018-03-24Fix ratio limit in documentationGustavo Rodrigues
The value of ratio isn't limited to 0-1, which can be checked in the two first links below. It probably was a mistake caused by copy-pasting the documentation of "progress", which is limited to 0-1. The commit where this extra info was added is the one in the third link. - https://github.com/webtorrent/webtorrent/blob/b53d224cdea46173ea97dc9eea7eaf5a6e7a55b9/lib/torrent.js#L177-L179 - https://github.com/webtorrent/webtorrent/blob/b53d224cdea46173ea97dc9eea7eaf5a6e7a55b9/index.js#L195-L205 - https://github.com/webtorrent/webtorrent/commit/6f2e85cd4649b3f1ddd67be9f4832c0138849b3e As this value is the result of something like `uploaded / max(1, downloaded)` it never get's to `Infinity`, so it's limited by 0 and `uploaded`. Without the ` || 1` part it would be limited between 0 and infinity.
2018-01-12Add hostname option to mitigate DNS rebindingyan
This adds the `hostname` opt to allow the server to validate the `Host` header of incoming requests to prevent DNS rebinding attacks. Needed for https://github.com/brave/browser-laptop/issues/12616.
2017-10-02Updated docs and README to show Safari supportLukaKerr
2017-06-25Merge pull request #1096 from webtorrent/feross/corsDiego R. B
Add `origin` option for torrent.createServer()
2017-06-01added file.progress property, along with documentationAsh
2017-04-15feross -> webtorrentFeross Aboukhadijeh
2017-04-08Add `origin` option for torrent.createServer()Feross Aboukhadijeh
When the origin option is specified, only requests from the given origin will be allowed. This is useful to add additional security to any app that is starting a WebTorrent server but doesn't want it to be exposed to the entire Web.
2017-03-31update docs with new sintel torrentFeross Aboukhadijeh
2017-03-17doc: torrent.createServer() takes a function argumentFeross Aboukhadijeh
2017-03-09Update api.mdFeross Aboukhadijeh
2017-03-09renderto exampleAnthony Ettinger
2017-01-12Notify user for file.deselect featureChuong
2017-01-11docs: clarify wordingFeross Aboukhadijeh
2017-01-11Until it is fixed, let notify webtorrent userChuong
https://github.com/feross/webtorrent/issues/1000
2016-11-23document "file.downloaded"Feross Aboukhadijeh
2016-10-14Remove tracker.webtorrent.io referencesFeross Aboukhadijeh
2016-09-17Option to disable BEP19 web seedsDC
2016-08-23docs: better docs for .renderTo()Feross Aboukhadijeh
2016-08-04Add options to disable autoplay/hide controlsFeross Aboukhadijeh
Fix #878.
2016-07-27Clarify 'error' event handling in docsFeross Aboukhadijeh
2016-06-15API: Add file.getBlob() methodFeross Aboukhadijeh
Get a W3C `Blob` object which contains the file data. The file will be fetched from the network with highest priority, and `callback` will be called once the file is ready. `callback` must be specified, and will be called with a an `Error` (or `null`) and the `Blob` object.
2016-05-08Move tracker options into `opts.tracker`Feross Aboukhadijeh
Closes #649 Based on a PR by @nkittsteiner. #791
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-28 20:37:14 +0300