@ctrl/qbittorrent 9.5.1 → 9.6.0

package/dist/src/qbittorrent.d.ts

@@ -79,11 +79,9 @@ export declare class QBittorrent implements TorrentClient {
      * @param category Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category")
      * @returns list of torrents
      */
-    listTorrents({ hashes, torrent_hashes, filter, status_filter, category, sort, offset, reverse, tag, limit, isPrivate, include_trackers, }?: {
+    listTorrents({ hashes, filter, category, sort, offset, reverse, tag, limit, isPrivate, includeTrackers, }?: {
         hashes?: string | string[];
-        torrent_hashes?: string | string[];
         filter?: TorrentFilters;
-        status_filter?: TorrentFilters;
         sort?: string;
         tag?: string;
         category?: string;
@@ -95,7 +93,7 @@ export declare class QBittorrent implements TorrentClient {
          * Renamed to avoid conflict with `private` keyword.
          */
         isPrivate?: boolean;
-        include_trackers?: boolean;
+        includeTrackers?: boolean;
     }): Promise<Torrent[]>;
     getAllData(): Promise<AllClientData>;
     /**
@@ -180,10 +178,18 @@ export declare class QBittorrent implements TorrentClient {
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents}
      */
+    stopTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
+    /**
+     * @deprecated Alias for {@link stopTorrent}.
+     */
     pauseTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents}
      */
+    startTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
+    /**
+     * @deprecated Alias for {@link startTorrent}.
+     */
     resumeTorrent(hashes: string | string[] | 'all'): Promise<boolean>;
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents}

package/dist/src/qbittorrent.js

@@ -139,20 +139,30 @@ export class QBittorrent {
      * @param category Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category")
      * @returns list of torrents
      */
-    async listTorrents({ hashes, torrent_hashes, filter, status_filter, category, sort, offset, reverse, tag, limit, isPrivate, include_trackers, } = {}) {
+    async listTorrents({ hashes, filter, category, sort, offset, reverse, tag, limit, isPrivate, includeTrackers, } = {}) {
         const params = {};
         if (hashes) {
             params.hashes = normalizeHashes(hashes);
         }
-        if (torrent_hashes) {
-            params.torrent_hashes = normalizeHashes(torrent_hashes);
-        }
         if (filter) {
+            if (this.state.version?.isVersion5OrHigher) {
+                if (filter === 'paused') {
+                    filter = 'stopped';
+                }
+                else if (filter === 'resumed') {
+                    filter = 'running';
+                }
+            }
+            else if (filter === 'stopped') {
+                // For versions < 5
+                filter = 'paused';
+            }
+            else if (filter === 'running') {
+                // For versions < 5
+                filter = 'resumed';
+            }
             params.filter = filter;
         }
-        if (status_filter) {
-            params.status_filter = status_filter;
-        }
         if (category !== undefined) {
             params.category = category;
         }
@@ -174,8 +184,8 @@ export class QBittorrent {
         if (isPrivate) {
             params.private = JSON.stringify(isPrivate);
         }
-        if (include_trackers) {
-            params.include_trackers = JSON.stringify(include_trackers);
+        if (includeTrackers) {
+            params.includeTrackers = JSON.stringify(includeTrackers);
         }
         const res = await this.request('/torrents/info', 'GET', params);
         return res;
@@ -371,16 +381,22 @@ export class QBittorrent {
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents}
      */
-    async pauseTorrent(hashes) {
+    async stopTorrent(hashes) {
         const endpoint = this.state.version?.isVersion5OrHigher ? '/torrents/stop' : '/torrents/pause';
         const data = { hashes: normalizeHashes(hashes) };
         await this.request(endpoint, 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
+    /**
+     * @deprecated Alias for {@link stopTorrent}.
+     */
+    async pauseTorrent(hashes) {
+        return this.stopTorrent(hashes);
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents}
      */
-    async resumeTorrent(hashes) {
+    async startTorrent(hashes) {
         const endpoint = this.state.version?.isVersion5OrHigher
             ? '/torrents/start'
             : '/torrents/resume';
@@ -388,6 +404,12 @@ export class QBittorrent {
         await this.request(endpoint, 'POST', undefined, objToUrlSearchParams(data));
         return true;
     }
+    /**
+     * @deprecated Alias for {@link startTorrent}.
+     */
+    async resumeTorrent(hashes) {
+        return this.startTorrent(hashes);
+    }
     /**
      * {@link https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents}
      * @param deleteFiles (default: false) remove files from disk

package/dist/src/types.d.ts

@@ -20,7 +20,15 @@ export interface BuildInfo {
      */
     bitness: string;
 }
-export type TorrentFilters = 'all' | 'downloading' | 'seeding' | 'completed' | 'paused' | 'stopped' | 'active' | 'inactive' | 'resumed' | 'running' | 'stalled' | 'stalled_uploading' | 'stalled_downloading' | 'checking' | 'moving' | 'errored';
+/**
+ * @deprecated Replaced by 'running' in qBittorrent v5.
+ */
+type TorrentFilterResumed = 'resumed';
+/**
+ * @deprecated Replaced by 'stopped' in qBittorrent v5.
+ */
+type TorrentFilterPaused = 'paused';
+export type TorrentFilters = 'all' | 'downloading' | 'seeding' | 'completed' | TorrentFilterPaused | 'stopped' | 'active' | 'inactive' | TorrentFilterResumed | 'running' | 'stalled' | 'stalled_uploading' | 'stalled_downloading' | 'checking' | 'moving' | 'errored';
 export interface Torrent {
     /**
      * Torrent name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/qbittorrent",
-  "version": "9.5.1",
+  "version": "9.6.0",
   "description": "TypeScript api wrapper for qbittorrent using got",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -42,22 +42,21 @@
     "cookie": "^1.0.2",
     "node-fetch-native": "^1.6.6",
     "ofetch": "^1.4.1",
-    "type-fest": "^4.39.1",
-    "ufo": "^1.5.4",
+    "type-fest": "^4.40.0",
+    "ufo": "^1.6.1",
     "uint8array-extras": "^1.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.3.4",
+    "@ctrl/eslint-config-biome": "4.3.5",
     "@eslint/compat": "^1.2.8",
     "@sindresorhus/tsconfig": "7.0.0",
-    "@types/cookie": "1.0.0",
-    "@types/node": "22.14.0",
+    "@types/node": "22.14.1",
     "@vitest/coverage-v8": "3.1.1",
-    "eslint": "^9.23.0",
+    "eslint": "^9.25.0",
     "p-wait-for": "5.0.2",
-    "typedoc": "0.28.1",
-    "typescript": "5.8.2",
+    "typedoc": "0.28.3",
+    "typescript": "5.8.3",
     "vitest": "3.1.1"
   },
   "release": {
@@ -67,5 +66,6 @@
   },
   "engines": {
     "node": ">=18"
-  }
+  },
+  "packageManager": "pnpm@10.8.1"
 }