From b27922d11dfee0e669e3784c6d8cffe9c1166426 Mon Sep 17 00:00:00 2001 From: James Halliday Date: Thu, 24 Mar 2016 18:10:17 -0700 Subject: provide the torrent instance in the opts.store() options --- docs/api.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs') diff --git a/docs/api.md b/docs/api.md index 3a06171..94cb519 100644 --- a/docs/api.md +++ b/docs/api.md @@ -63,6 +63,13 @@ If you want access to the torrent object immediately in order to listen to event metadata is fetched from the network, then use the return value of `client.add`. If you just want the file data, then use `ontorrent` or the 'torrent' event. +If you provide `opts.store`, it will be called as +`opts.store(chunkLength, storeOpts)` with: + +* `storeOpts.length` - size of all the files in the torrent +* `storeOpts.files` - an array of torrent file objects +* `storeOpts.torrent` - the torrent instance being stored + ## `client.seed(input, [opts], [function onseed (torrent) {}])` Start seeding a new torrent. -- cgit v1.2.3