qBitorrent 数据

类型脚本 api 包装 qBitorrent 数据 使用 函数

安装

npm install @ctrl/qbittorrent

要求节点.js 24或更新.

使用

import { QBittorrent } from '@ctrl/qbittorrent';

const client = new QBittorrent({
  baseUrl: 'http://localhost:8080/',
  username: 'admin',
  password: 'adminadmin',
});

async function main() {
  const res = await client.getAllData();
  console.log(res);
}

认证

默认认证模式使用 qBittorrent 的用户名/ password 登录流量 并存储返回的 WebUI 会话 cookie.

qBittorrent v5.2.0和WebAPI v2.14.1增加了API密钥认证. 通过 API 键来使用无国籍的无记名认证而不是 cookie 登录 :

const client = new QBittorrent({
  baseUrl: 'http://localhost:8080/',
  apiKey: 'qbt_0000000000000000000000000000',
});

API 键可以从 qBittorrent WebUI 创建. 它们也可被旋转或 通过 WebAPI 删除 :

const passwordClient = new QBittorrent({
  baseUrl: 'http://localhost:8080/',
  username: 'admin',
  password: 'adminadmin',
});

const apiKey = await passwordClient.rotateApiKey();
await passwordClient.deleteApiKey();

API 密码

文档 : https://qbittorrent.ep.works.dev 互联网档案馆的存檔,存档日期2013-12-02
qBittorrent API Docs: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent- 5
qBittorrent API 密钥文档 : https://github.com/qbittorrent/qBittorrent/wiki/API-Key-Authentication-%28% E2%-89% A5v5.2.0%29 互联网档案馆的存檔,存档日期2014-12-20

与其他客户不同的事情:

• label 是 qBitorrent 类
• qBittorrent 忽略未知的散列, 暂停、 恢复、 排队和删除, 不为它们丢弃
• queueUp编号 :queueDown 需要种子队列已启用, qBittorrent 以 409 回复 . queuePosition 实值 0 当队列被禁用或种子正在播种时
• pauseTorrent编号 :resumeTorrent 使用情况 /torrents/stop 财务报告和审定财务报表 /torrents/start 关于qBitorrent 5和 /torrents/pause 财务报告和审定财务报表 /torrents/resume 在4.x时

规范化 API

这些职能通过 @ ctrl/ 共享调用,这使得支持多个 torrent客户端更加容易. 见 下级 用于支持种子客户端.

获取全部数据

返回所有种子数据和一系列标签对象。 数据已经正常化, 不符合本地输出 listTorrents()。 。 。 .

const data = await client.getAllData();
console.log(data.torrents);

获取Torrent

从种子散列返回一个种子数据h

const data = await client.getTorrent('torrent-hash');
console.log(data);

暂停 Torrent 并恢复 Torrent

暂停或恢复一个或多个种子

await client.pauseTorrent('torrent-hash');
await client.resumeTorrent(['torrent-hash', 'other-torrent-hash']);

删除Torrent

删除一个或多个种子 。 不默认删除磁盘上的数据 .

// does not remove data on disk
await client.removeTorrent('torrent-hash', false);

// remove data on disk
await client.removeTorrent(['torrent-hash', 'other-torrent-hash'], true);

上下队列

上下移动种子队列

await client.queueUp('torrent-hash');
await client.queueDown('torrent-hash');

添加托伦特

从磁铁链接或种子文件中添加种子, 有客户端特定选项 。 另见已规范的Add-Torrent

import { readFileSync } from 'node:fs';

const result = await client.addTorrent(new Uint8Array(readFileSync('./linux.torrent')));
console.log(result);

已正常化 添加托伦特

添加 torrent并返回已归正的 torrent 数据, 可以启动已暂停的 torrent并添加标签

const result = await client.normalizedAddTorrent('magnet:?xt=urn:btih:...', {
  startPaused: false,
  label: 'linux',
});
console.log(result);

错误

请求抛出失败 TorrentClientError 从 @ ctrl/ 共享调用 带有 code 联 合 国 torrent_not_found, (中文(简体) ), unauthorized, (中文(简体) ), request_failed 或者说 client_error,该网址 status 当有一个, 原始错误作为 cause。 。 。 .

import { TorrentClientError } from '@ctrl/qbittorrent';

try {
  await client.getTorrent('torrent-hash');
} catch (error) {
  if (error instanceof TorrentClientError && error.code === 'torrent_not_found') {
    // not in the client
  }
}

从国家导出并创建

如果您经常关闭服务器( 无服务器 ) , 您可以导出状态

const state = client.exportState();
const restored = QBittorrent.createFromState(config, state);

另见

以下 npm 模块都提供相同的正态函数,同时为每个客户端支持独特的apis.

• 共享类型 - @ ctrl/ 共享调用
• 潮水 - @ ctrl/ 清除
• 传输 - @ctrl/ 转发
• 餐饮 @ ctrl/ 用户
• 特伦特 - @ ctrl/ 特伦特
• 克比特语 - @ ctrl/ rqbit

Usenet 客户端采用相同的常态化方法:

• 用户网共享类型 - @ctrl/ 共享用户网
• nzbget - (英语) @ ctrl/ nzbget (英语)
• 萨布兹布德 - @ctrl/sabnzbd (英语)

启动一个测试嵌入容器

docker run -d \
  --name=qbittorrent \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WEBUI_PORT=8080 \
  -p 8080:8080 \
  -p 6881:6881 \
  -p 6881:6881/udp \
  --restart unless-stopped \
  lscr.io/linuxserver/qbittorrent:latest

为 qBittorrent alpha 启动一个测试嵌入容器

在测试最新的WebAPI更改时使用官方的α图像. 这个 linux 服务器 latest 图像可以落后于最新的 qBittorrent 发布.

mkdir -p /tmp/qbittorrent-alpha/config /tmp/qbittorrent-alpha/downloads

docker run -d \
  --name=qbittorrent-alpha \
  -e QBT_LEGAL_NOTICE=confirm \
  -e QBT_WEBUI_PORT=8080 \
  -e QBT_TORRENTING_PORT=6881 \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 8080:8080 \
  -p 6881:6881 \
  -p 6881:6881/udp \
  -v /tmp/qbittorrent-alpha/config:/config \
  -v /tmp/qbittorrent-alpha/downloads:/downloads \
  qbittorrentofficial/qbittorrent-nox:alpha

Alpha 图像在 docker logs qbittorrent-alpha设置 WebUI 密码到 adminadmin 运行前 综合测试.