diff options
| author | Feross Aboukhadijeh <feross@feross.org> | 2015-08-22 18:35:02 +0300 |
|---|---|---|
| committer | Feross Aboukhadijeh <feross@feross.org> | 2015-08-22 18:35:02 +0300 |
| commit | a14123fa14f78615d80a6bfd70b0cd91ef11ac13 (patch) | |
| tree | 667892e4d2a0e13383995c389817d5ab8141cd7a /README.md | |
| parent | 384b442f66d94e8e01eee499f69141727c925840 (diff) | |
BREAKING: rename `torrent.storage` to `torrent.store`
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -254,7 +254,7 @@ If `opts` is specified, then the default options (shown below) will be overridde { announce: [], // List of additional trackers to use (added to list in .torrent or magnet uri) path: String, // Folder where files will be downloaded (default=`/tmp/webtorrent/`) - storage: Function, // Custom storage engine (must follow `abstract-chunk-store` API) + store: Function, // Custom chunk store (must follow `abstract-chunk-store` API) verify: Boolean // Verify previously stored data before starting (default=false) } ``` @@ -289,7 +289,7 @@ If `onseed` is specified, it will be called when the client has begun seeding th #### `client.on('torrent', function (torrent) {})` -Emitted when a torrent is ready to be used (i.e. metadata is available and storage is +Emitted when a torrent is ready to be used (i.e. metadata is available and store is ready). See the torrent section for more info on what methods a `torrent` has. #### `client.remove(torrentId, [function callback (err) {}])` |