nom, please more

    @ctrl/utorrent
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.0 • Public • Published

    utorrent

    npm CircleCI coverage

    TypeScript api wrapper for utorrent using got

    Install

    npm install @ctrl/utorrent

    Use

    import { Utorrent } from '@ctrl/utorrent';
    
    const client = new Utorrent({
      baseUrl: 'http://localhost:44822/',
      path: '/gui/',
      password: 'admin',
    });
    
    async function main() {
      const res = await client.getAllData();
      console.log(res);
    }

    API

    DOCS: https://utorrent.vercel.app utorrent webui: https://github.com/bittorrent/webui/blob/master/webui.js
    another webui link: https://github.com/bittorrent/webui/wiki/Web-UI-API

    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 from hash id

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

    Pause or resume a torrent

    const paused = await client.pauseTorrent('torrent-hash');
    console.log(paused);
    const resumed = await client.resumeTorrent('torrent-hash');
    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

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

    Install

    npm i @ctrl/utorrent

    DownloadsWeekly Downloads

    23

    Version

    3.2.0

    License

    MIT

    Unpacked Size

    25.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • scttcper