aria2

aria2.js

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

• Introduction
• 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
    • system.multicall
    • system.listMethods
    • system.listNotifications
  • aria2 events
    • onDownloadStart
    • onDownloadPause
    • onDownloadStop
    • onDownloadComplete
    • onDownloadError
    • onBtDownloadComplete
• Example
• Contributing

Introduction

aria2.js controls aria2 via its JSON-RPC interface and features

• Node.js and browsers support
• multiple transports
  • HTTP
  • WebSocket
  • JSONP
• callback API
• promise API
• light (1.5KB minified and gzipped)

↑

Getting started

npm install aria2

---

var Aria2 = require('aria2');

or

<!-- optional for HTTP/JSONP support -->
<script src="node_modules/httpclient/bundle.js"></script>
<script src="node_modules/aria2/bundle.js"></script>

var Aria2 = window.Aria2

---

Start aria2c in daemon mode with

aria2c --enable-rpc --rpc-listen-all=true --rpc-allow-origin-all

↑

Usage

var aria2 = new Aria2([options]);

default options match aria2c defaults and are

{
  host: 'localhost',
  port: 6800,
  secure: false,
  secret: '',
  path: '/jsonrpc',
  jsonp: false
}

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

If the WebSocket is open (via the open method) aria2.js will use the WebSocket transport, otherwise the HTTP transport.

jsonp: true will make aria2.js uses JSONP for non WebSocket requests, useful if you cannot make aria2c allow your origin. It has no effect on Node.js.

↑

open

aria2.open() opens the WebSocket connection.

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

aria2.open([cb]);
// or
aria2.open().then(fn)

↑

close

aria2.close() closes the WebSocket connection.

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

aria2.close([cb]); // callback style
// or
aria2.close().then(fn); // promise style

↑

onsend and onmessage

aria2.onsend() is called for every message sent. aria2.onmessage() is called for every message received.

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

↑

aria2 methods

For a complete listing see aria2 methods.

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

For every aria2 methods you can use

callback style

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

or

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

promise style

aria2.getVersion([params,]).then(fn)

or

aria2.send('getVersion', [params,]).then(fn)

↑

aria2 events

For a complete listing see aria2 notifications.

For every notifications you can bind a function.

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

↑

Example

See example.js

↑

Tests

npm install mocha standard
npm test

↑

Contributing

See CONTRIBUTING.md

↑