Giter VIP home page Giter VIP logo

transmission's Introduction

transmission npm coverage status

TypeScript api wrapper for transmission using ofetch

Install

npm install @ctrl/transmission

Use

import { Transmission } from '@ctrl/transmission';

const client = new Transmission({
  baseUrl: 'http://localhost:9091/',
  password: '',
});

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

Api

Docs: https://transmission.vercel.app
API Docs: https://github.com/transmission/transmission/blob/master/extras/rpc-spec.txt

Normalized API

These functions have been normalized between torrent clients. Can easily support multiple torrent clients. See below for alternative supported torrent clients

getAllData

Returns all torrent data and an array of label objects. Data has been normalized and does not match the output of native listTorrents().

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

Returns one torrent data

const data = await client.getTorrent();
console.log(data);
pauseTorrent and resumeTorrent

Pause or resume a torrent

const paused = await client.pauseTorrent();
console.log(paused);
const resumed = await client.resumeTorrent();
console.log(resumed);
removeTorrent

Remove a torrent. Does not remove data on disk by default.

// does not remove data on disk
const result = await client.removeTorrent('torrent_id', false);
console.log(result);

// remove data on disk
const res = await client.removeTorrent('torrent_id', true);
console.log(res);

See Also

All of the following npm modules provide the same normalized functions along with supporting the unique apis for each client.

deluge - https://github.com/scttcper/deluge
qbittorrent - https://github.com/scttcper/qbittorrent
utorrent - https://github.com/scttcper/utorrent

Start a test docker container

docker run -d \
  --name=transmission \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 9091:9091 \
  -p 51413:51413 \
  -p 51413:51413/udp \
  -v ~/Documents/transmission/config:/config \
  -v ~/Documents/transmission/downloads:/downloads \
  -v ~/Documents/transmission/watch:/watch \
  --restart unless-stopped \
  lscr.io/linuxserver/transmission:latest

transmission's People

Contributors

dependabot[bot] avatar klesh avatar renovate-bot avatar scttcper avatar xfoxfu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

transmission's Issues

Feature request: Add `hash` to `NormalizedTorrent`

Hello there 👋

Do you think you can add a hash field to the NormalizedTorrent type?

The problem I am having with Transmission is that restarting the service causes the torrent IDs to change.
The only unique data I have found is the hashString property.
It would be super cool to have it directly on the normalized data 🤌

Thanks !

addMagnet is not in interface TorrentClient

All the Torrent Client packages have a public function addMagnet but this is not defined in the TorrentClient interface. Suggest that either:

  1. It gets added to allow access from generically defined torrent client
  2. The normalizedAddTorrent function checks if the URL is a magnet and calls it internally.

Suggested code for 2 is below:

if (url.startsWith("magnet:")) {
      const torrent = await client.addMagnet(url, {paused: !autoDownload});
      const hashString = torrent.arguments["torrent-added"].hashString;
      return this.client.getTorrent(hashString);
}

any chance using this in Web?

At first, thanks for your work.

I'm writing a transmission Web ui and looking for a client sdk. But got is for nodejs runtime, have you consider support this in Web runtime?

Browser will request loop login when using typescript

Hi,
I want to using @ctrl/transmission in a react project that based on typescript, but the browser always popup a transmission server login dialog, and this will displayed in a loop after each login. In final it will get 401 error.
But when I using in a javascript react project, it will login automation.

In typescript:
image

Thanks for your attention!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.