@imohuan/aria2c v0.0.8

Aria2c

官网文档

参数 https://aria2.github.io/manual/en/html/aria2c.html

函数 https://aria2.github.io/manual/en/html/aria2c.html?highlight=adduri

UI 界面 http://aria2.baisheng999.com/

声明

export declare class Aria2Tool extends Aria2 {
  private keys;
  constructor(option?: Aria2ToolOption | Aria2ToolOption[]);
  /**
   * 连接 Aria2c 时，调用方法
   */
  open(): Promise<any>;
  close(): Promise<any>;
  call(...args: any[]): Promise<any>;
  /**
   * 批处理指令 [ [methodA, param1, param2], [methodA, param1, param2] ]
   * 如果任一指令出现错误，返回一种结果
   * @param multicall
   * @returns
   */
  multicall(multicall: any[][]): any;
  /**
   * 同 multicall 但会返回多种结果
   * @param batch
   * @returns
   */
  batch(batch: any[][]): any;
  /**
   * 获取 aria2 监听事件 on调用
   */
  getEventNames(): Promise<string[]>;
  /**
   * 获取 aria2 方法 call调用
   */
  getMethodNames(): any;
  /**
   * 监听事件
   * @param key getEventNames() keys
   * @param callback 回调方法
   */
  on(key: string, callback: Function): void;
  /**
   * 将对象中的类型转换为字符串类型
   */
  private objValueToString;
  /**
   * 添加下载连接
   * @param urls 下载地址
   * @param option 下载配置
   * @param position 位置位置
   * @returns 添加下载后的 id
   */
  addUri(
    urls: string | string[],
    option?: Aria2ToolDownloadOption,
    position?: number
  ): Promise<string>;
  /**
   * 修改当前最大同时下载数
   * @returns OK
   */
  setMaxConcurrentDownloads(size: number): Promise<string>;
  /**
   * 获取全局下载配置
   */
  getGlobalOption(): Promise<Aria2ToolDownloadOption>;
  /**
   * 获取任务的下载配置
   * @param gid 任务id
   * @returns 配置文件
   */
  getOption(gid: string): Promise<Aria2ToolDownloadOption>;
  /**
   * 获取任务 状态，上传速度，文件大小， 保存位置
   * @param gid 任务id
   * @param keys 需要返回的字段数组
   * @returns
   */
  getStatus(gid: string, keys?: string[]): Promise<any>;
  /**
   * 获取任务  Url
   * @param gid 任务id
   * @returns { uri, status }
   */
  getUrl(gid: string): Promise<{
    uri: string;
    status: string;
  }>;
  /**
   * 获取正在下载的列表数据
   * @param keys 需要返回的字段数组
   * @returns 包含keys字段的列表对象
   */
  getActiveList(keys?: string[]): Promise<any[]>;
  /**
   * 获取等待和已暂停的列表数据 默认返回所有数据(0, 999)
   * @param start 数据开始位置
   * @param end 数据结束位置
   * @param keys 需要返回的字段数组
   * @returns 包含keys字段的列表对象
   * @example getWaitingList(0, 1) returns ["A"]
   * getWaitingList(1, 2) returns ["B", "C"]
   * getWaitingList(-1, 2) returns ["C", "B"].
   */
  getWaitingList(start?: number, end?: number, keys?: string[]): any;
  /**
   * 获取已停止结束的列表数据 默认返回所有数据(0, 999)
   * @param start 数据开始位置
   * @param end 数据结束位置
   * @param keys 需要返回的字段数组
   * @returns 包含keys字段的列表对象
   * @example getWaitingList(0, 1) returns ["A"]
   * getWaitingList(1, 2) returns ["B", "C"]
   * getWaitingList(-1, 2) returns ["C", "B"].
   */
  getStoppedList(start?: number, end?: number, keys?: string[]): any;
  /**
   * 删除任务
   * @param gid 任务id
   * @returns gid
   */
  remove(gid: string): Promise<string>;
  /**
   * 删除任务文件 (已完成/错误/删除的下载)
   * @param gid 任务id
   * @returns OK
   */
  removeResult(gid: string): Promise<string>;
  /**
   * 删除所有任务文件 (已完成/错误/删除的下载)
   * @returns OK
   */
  removeAll(): Promise<string>;
  /**
   * 暂停任务
   * @param gid 任务id
   * @returns gid
   */
  pause(gid: string): Promise<string>;
  /**
   * 暂停所有任务
   * @returns OK
   */
  pauseAll(): Promise<string>;
  /**
   * 恢复等待任务 (开始任务)
   * @param gid 任务id
   * @returns gid
   */
  unpause(gid: string): Promise<string>;
  /**
   * 恢复全部任务为等待任务 (开始所有任务)
   * @returns OK
   */
  unpauseAll(): Promise<string>;
}