libaria2-ts
Advanced tools
Comparing version 1.0.52 to 1.0.53
@@ -13,3 +13,3 @@ /// <reference types="node" /> | ||
abstract getSessionInfo(): Promise<IAria2ClientSessionInfo>; | ||
abstract addUri(uris: string[] | string, options?: IAria2ClientOptions, position?: number): Promise<TAria2ClientGID>; | ||
abstract addUri(uris: string[] | string, options?: TAria2ClientInputOption, position?: number): Promise<TAria2ClientGID>; | ||
abstract addTorrent(torrent: Buffer | string, uris?: string[] | string, options?: IAria2ClientOptions, position?: number): Promise<TAria2ClientGID>; | ||
@@ -16,0 +16,0 @@ abstract addMetalink(metalink: Buffer | string, options?: IAria2ClientOptions, position?: number): Promise<TAria2ClientGID[]>; |
import * as Rpc from "./rpc"; | ||
import * as Adapter from "./adapter"; | ||
import * as Spawn from "./spawn"; | ||
export declare const WebSocketClient: typeof Rpc.Aria2.WebSocket.Client; | ||
export declare const HttpClient: typeof Rpc.Aria2.Http.Client; | ||
export { Rpc, Adapter, Spawn }; | ||
export { Rpc, Adapter }; | ||
//# sourceMappingURL=lib.d.ts.map |
@@ -22,3 +22,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.Spawn = exports.Adapter = exports.Rpc = exports.HttpClient = exports.WebSocketClient = void 0; | ||
exports.Adapter = exports.Rpc = exports.HttpClient = exports.WebSocketClient = void 0; | ||
const Rpc = __importStar(require("./rpc")); | ||
@@ -28,6 +28,5 @@ exports.Rpc = Rpc; | ||
exports.Adapter = Adapter; | ||
const Spawn = __importStar(require("./spawn")); | ||
exports.Spawn = Spawn; | ||
// import * as Spawn from "./spawn"; | ||
exports.WebSocketClient = Rpc.Aria2.WebSocket.Client; | ||
exports.HttpClient = Rpc.Aria2.Http.Client; | ||
//# sourceMappingURL=lib.js.map |
@@ -321,3 +321,3 @@ /// <reference types="node" /> | ||
*/ | ||
addUri(uris: string[] | string, options?: IAria2ClientOptions, position?: number): Promise<TAria2ClientGID>; | ||
addUri(uris: string[] | string, options?: TAria2ClientInputOption, position?: number): Promise<TAria2ClientGID>; | ||
/** | ||
@@ -324,0 +324,0 @@ * This method adds a BitTorrent download by uploading a ".torrent" file. If you want to add a BitTorrent Magnet URI, use the `aria2.addUri()` method instead. torrent must be a base64-encoded string containing the contents of the ".torrent" file. uris is an array of URIs (string). uris is used for Web-seeding. For single file torrents, the URI can be a complete URI pointing to the resource; if URI ends with /, name in torrent file is added. For multi-file torrents, name and path in torrent are added to form a URI for each file. options is a struct and its members are pairs of option name and value. See Options below for more details. If position is given, it must be an integer starting from 0. The new download will be inserted at position in the waiting queue. If position is omitted or position is larger than the current size of the queue, the new download is appended to the end of the queue. This method returns the GID of the newly registered download. If `--rpc-save-upload-metadata` is `true`, the uploaded data is saved as a file named as the hex string of SHA-1 hash of data plus ".torrent" in the directory specified by `--dir` option. E.g. a file name might be `0a3893293e27ac0490424c06de4d09242215f0a6.torrent`. If a file with the same name already exists, it is overwritten! If the file cannot be saved successfully or `--rpc-save-upload-metadata` is `false`, the downloads added by this method are not saved by `--save-session`. |
@@ -753,3 +753,3 @@ "use strict"; | ||
if (options != undefined) | ||
args.push(options); | ||
args.push(parser_1.fromTAria2ClientInputOption(options)); | ||
if (options != undefined && position != undefined) | ||
@@ -756,0 +756,0 @@ args.push(options); |
{ | ||
"name": "libaria2-ts", | ||
"version": "1.0.52", | ||
"version": "1.0.53", | ||
"description": "A full-typing wrapper around `aria2`, `The next generation download utility`.", | ||
@@ -5,0 +5,0 @@ "repository": "https://github.com/im-oxygen/libaria2-ts/", |
@@ -30,2 +30,3 @@ # [libaria2.ts](https://www.npmjs.com/package/libaria2-ts) | ||
# Getting Started | ||
Install this package | ||
@@ -41,3 +42,2 @@ ``` | ||
Start aria2 with rpc, example | ||
@@ -47,11 +47,3 @@ ``` | ||
``` | ||
or use TypeScript API | ||
```ts | ||
import { Spawn } from 'libaria2-ts'; | ||
const aria2Srv = new Spawn.Aria2Process({ | ||
aria2cPath: "<your aria2c path>", | ||
}); | ||
await aria2Srv.spawn(); // Spawn Process | ||
await aria2Srv.process.kill() // Kill Process | ||
``` | ||
~~or use TypeScript API~~ (deprecated) | ||
@@ -58,0 +50,0 @@ # Usage |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
171634
30
2193
89