JavaScript (Node.js and browsers) library for aria2, "The next generation download utility."

aria2.js controls aria2 via its JSON-RPC interface and supports WebSocket, HTTP and JSONP transports.

• Getting started
• Usage
  • open
  • close
  • onsend and onmessage
  • aria2 methods
    • addUri
    • addTorrent
    • addMetaLink
    • remove
    • forceRemove
    • pause
    • pauseAll
    • forcePause
    • forcePauseAll
    • unpause
    • unpauseAll
    • tellStatus
    • getUris
    • getFiles
    • getPeers
    • getServers
    • tellActive
    • tellWaiting
    • tellStopped
    • changePosition
    • changeUri
    • getOption
    • changeOption
    • getGlobalOption
    • changeGlobalOption
    • getGlobalStat
    • purgeDownloadResult
    • removeDownloadResult
    • getVersion
    • getSessionInfo
    • shutdown
    • forceShutdown
    • saveSession
  • aria2 events
    • onDownloadStart
    • onDownloadPause
    • onDownloadStop
    • onDownloadComplete
    • onDownloadError
    • onBtDownloadComplete
• Example
• Contributing

npm install aria2

var Aria2 = require('aria2');

or

<script src="node_modules/aria2/lib/index.js"></script>

var Aria2 = window.Aria2

↑

var aria2 = new Aria2([options]);

default options are

{
  host: 'localhost',
  port: 6800,
  secure: false,
  secret: ''
}

Secret is optional and refers to --rpc-secret.

↑

aria2.open() opens the WebSocket connection.

aria2.onopen = function() {
  console.log('aria2 open');
};
aria2.open();

↑

aria2.close() closes the WebSocket connection.

aria2.onclose = function() {
  console.log('aria2 closed!');
};
aria2.close();

↑

aria2.onsend() is called everytime a message is being sent aria2.onmessage() is called everytime a message has been received.

aria2.onsend = function(m) {
  console.log('aria2 OUT', m);
};
aria2.onmessage = function(m) {
  console.log('aria2 IN', m);
};

↑

For a complete listing see aria2 methods.

Note that if you have passed the secret option to aria2.js, it will be automatically added it to every request so there is no need to include it.

When sending a request to aria2, if the WebSocket is closed, aria2.js will use the HTTP transport.

For every aria2 methods you can use

aria2.getVersion([params,] function(err, res) {
  console.log(err || res);
});

or

aria2.send('getVersion', [params,] function(err, res) {
  console.log(err || res);
});

↑

For a complete listing see aria2 notifications.

For every notifications you can bind a function.

aria2.onDownloadStart = function(gid) {
  console.log(gid);
};

↑

See example.js

↑

npm install -g eslint mocha babel
npm test

↑

See CONTRIBUTING.md

↑