Giter Site home page Giter Site logo

ryanmarcus / node-deluge Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 0.0 15 KB

A simple Deluge NodeJs API interface/wrapper, asynchronous NodeJs module to interact with the Deluge torrent client API.

License: MIT License

Makefile 1.85% JavaScript 98.15%

node-deluge's Introduction

node-deluge

A simple Deluge NodeJs API interface/wrapper, asynchronous NodeJs module to interact with the Deluge torrent client API.

Build Status npm version GitHub license

INSTALLATION

npm install --save node-deluge

USAGE

First 'require' the package into your project node-deluge accepts 3 parameters as input:

  • hostname: your server's url, eg. deluge.nusrath.com or 192.168.1.111
  • password: your server's password
  • port: the port your server consumes - the default is 8112 , if you are running the default port, use null here
var deluge = require('node-deluge')(hostname, password, port).then(function (res) {
  // res is true if authentication is good, false otherwise.
});

Make use of the various methods

The syntax is as follows:

var deluge = require('node-deluge')(hostname, password, port).then(function (res) {
  // res is true if authentication is good, false otherwise.
  return deluge.getStatus(); // OR deluge.getConfig(), currently only two methods available
}).then(function (data) {
  // do something with the data..
  
  deluge.close(); // by default node-deluge keeps the connection open and so programs won't terminate without this
});

TODO

Include all methods mentioned in the link specified in the 'RESOURCES' section

RESOURCES

Deluge API documentation

node-deluge's People

Contributors

nunsie avatar ryanmarcus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

boelensman1

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.