diff --git a/docs/api.md b/docs/api.md index 0de88eae..ce049dc0 100644 --- a/docs/api.md +++ b/docs/api.md @@ -165,6 +165,8 @@ Always listen for the 'error' event. Remove a torrent from the client. Destroy all connections to peers and delete all saved file data. If `callback` is specified, it will be called when file data is removed. +*Note: This method does not currently delete torrent data (in e.g. `/tmp/webtorrent/...`, see the `path` option to `client.add`). Until this is fixed, please implement it yourself (consider using the `rimraf` npm package). + ## `client.destroy([function callback (err) {}])` Destroy the client, including all torrents and connections to peers. If `callback` is specified, it will be called when the client has gracefully closed.