Wondering what’s next for npm?Check out our public roadmap! »

    libaria2-ts
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.707 • Public • Published

    libaria2.ts

    npm bundle size GitHub repo file count npm GitHub Repo stars

    TypeScript (Node.js & Browser) library for aria2.

    Introduction

    libaria2.ts uses Aria2 JSON-RPC Interface to control it.

    Features

    • Node.js and browsers support
    • Multiple Transports
    • Promise-based API
    • Full-Typing, JSDoc

    Getting Started

    Install this package

    npm install --save libaria2-ts
    

    or

    yarn add libaria2-ts
    

    Start aria2 with rpc, example

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

    or use TypeScript API (deprecated)

    Usage

    Create client

    import { WebSocket as Aria2WebSocket } from "libaria2-ts";
    // or 
    //     import { Http as Aria2Http } from "libaria2-ts";
    
    const aria2 = new Aria2WebSocket({...});
    // or
    //     const aria2 = new Aria2Http({...});

    Example options

    {
      host: 'localhost',
      port: 6800,
      path: '/jsonrpc',
      auth: {
        secret: 'hello'
      }
    }

    Methods

    let ver = await aria2.getVersion();
    /*
     * Output:
     * { version: '...', enabledFeatues: [...] }
     */
    
    const resl = await aria2.system.multicall(
      { methodName: 'aria2.getVersion', params: [] },
      { methodName: 'aria2.addUri', params: ['http://example.com/qwer.zip'] }
    );
    /*
     * Output:
     * Array<Promise<...>>
     */
    
    let event = await aria2.when('aria2.onDownloadStart');
    console.log(`Download ${event.gid} Started`);
    
    // or:
    aria2.when('aria2.onDownloadStart').then((event: IAria2NotificationEvent) => {
      console.log(`Download ${event.gid} Started`);
    })
    
    // or:
    aria2.addEventListener('aria2.onDownloadStart', (event: IAria2NotificationEvent) => {
      console.log(`Download ${event.gid} Started`);
    });
    
    // or:
    aria2.onDownloadStart().then((event: IAria2NotificationEvent) => {
      console.log(`Download ${event.gid} Started`);
    }));
    
    
    
    await aria2.closeConnection();

    More methods, see Aria2ClientBaseClient

    License

    MIT License
    
    Copyright (c) 2021 Oxygen
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
    

    Install

    npm i libaria2-ts

    DownloadsWeekly Downloads

    48

    Version

    1.0.707

    License

    MIT

    Unpacked Size

    1.49 MB

    Total Files

    30

    Last publish

    Collaborators

    • avatar