Library	Windows CLI	SharedWorker	Browser Extension	Web UI & Electron App
aria2.js	aria2c.cmd	aria2-socket-worker.js	Download with Aria2	Aria2 Task Manager

Download SharedWorker

Bash

curl -L -O https://jc3213.github.io/aria2.js/sharedworker/aria2-socket-worker.js
curl -L -O https://jc3213.github.io/aria2.js/sharedworker/aria2-worker-client.js

Powershell

Invoke-WebRequest "https://jc3213.github.io/aria2.js/sharedworker/aria2-socket-worker.js" -OutFile "aria2-socket-worker.js"
Invoke-WebRequest "https://jc3213.github.io/aria2.js/sharedworker/aria2-worker-client.js" -OutFile "aria2-worker-client.js"

Syntax

File System

/aria2-socket-worker.js
/index.html
/index.js

Javascript

const worker = new SharedWorker('/aria2-socket-worker.js');
const port = worker.port;

port.start();

port.onmessage = function(event) {
    const message = event.data;
    const id = message.id;
    const type = message.type;
    const result = message.result;
    console.log(id, type, result);
};

port.postMessage({ id, type, payload });

id

• String / Number
  • Unique ID for the message

type

• String
  • connect
    • Set WebSocket url for aria2 JSON-RPC
    • Set secret token for aria2 JSON-RPC
    • Open WebSocket connection if not
    • Open new WebSocket connection if opened
    • payload = { jsonrpc, secret }
    • jsonrpc
    • secret
  • disconnect
    • Close WebSocket connection
  • subscribe
    • Add message port to the broadcast lists
  • unsubscribe
    • Remove message port from the broadcast lists
  • call
    • Send request to aria2 JSON-RPC
    • payload = { method, params }
    • method
    • params
  • multicall
    • Send multiple messages to aria2 JSON-RPC
    • payload = [ { methodName, params }, ... ]
    • methodName
    • params
  • ws:open
    • Triggers when WebSocket connection is opened
    • Only send messages to ports in the broadcast lists
  • ws:close
    • Handle notification events from WebSocket JSON-RPC
    • Only send messages to ports in the broadcast lists
  • ws:message
    • Triggers when WebSocket connection is closed
    • Only send messages to ports in the broadcast lists

File System

/aria2-socket-worker.js
/aria2-worker-client.js
/index.html
/index.js

HTML

<script src="/aria2-worker-client.js"></script>

Javascript

aria2.retries = 10; // Default
aria2.timeout = 10; // Default

console.log(await aria2.retries, await aria2.timeout);

aria2.onopen = function() {
    console.log("WebSocket connection is opened");
};

aria2.onclose = function() {
    console.log("WebSocket connection is closed");
};

aria2.onmessage = function(message) {
    console.log("Notification recieved from JSON-RPC", message);
};

await aria2.subscribe();
await aria2.connect(jsonrpc, secret);

• jsonrpc
• secret

let response = await aria2.call(method, params);

• method
• params

let response = await aria2.multicall([ { methodName, params }, ... ]);

• methodName
• params

jsonrpc

• String
• The URL of JSON-RPC of aria2 download ultility

secret

• String
• The secret token secret=your-secret-token in JSON-RPC configuration

method

• String
• Read RPC method calls

params

• Array
• JSON-RPC method call parameters