docs: improve documentation of delete torrents API

This commit is contained in:
Jesse Chan
2020-09-28 00:00:36 +08:00
parent 43b2d8fbbf
commit ab42dae278
5 changed files with 41 additions and 14 deletions
+9
View File
@@ -1,3 +1,5 @@
import {TorrentProperties} from './Torrent';
export interface AddTorrentByURLOptions {
urls: Array<string>;
destination: string;
@@ -14,3 +16,10 @@ export interface MoveTorrentsOptions {
moveFiles: boolean;
isCheckHash: boolean;
}
export interface DeleteTorrentsOptions {
// An array of string representing hashes of torrents to be removed
hashes: Array<TorrentProperties['hash']>;
// Whether to delete data of torrents
deleteData?: boolean;
}