Hierarchy

  • Client

Constructors

Properties

options: ClientOptions

Methods

  • Continue a task

    Parameters

    • id: string

      Task id

    Returns Promise<void>

  • Continue a batch of tasks

    Parameters

    • id: string[] = []

      Task id, can be multiple

    • status: TaskStatus[] = []

      Filter by task status, can be multiple

    • notStatus: TaskStatus[] = []

      Filter by excluding task status, can be multiple

    Returns Promise<void>

  • Create a new download task

    Parameters

    Returns Promise<string>

  • Create a batch of download tasks

    Parameters

    Returns Promise<string[]>

  • Delete a task

    Parameters

    • id: string

      Task id

    • force: boolean = false

      Delete files

    Returns Promise<void>

  • Delete a batch of tasks

    Parameters

    • id: string[] = []

      Task id, can be multiple

    • status: TaskStatus[] = []

      Filter by task status, can be multiple

    • notStatus: TaskStatus[] = []

      Filter by excluding task status, can be multiple

    • force: boolean = false

      Delete files

    Returns Promise<void>

  • Type Parameters

    • T

    Parameters

    • method: string
    • path: string
    • __namedParameters: {
          data?: object;
          query?: URLSearchParams;
      } = {}
      • Optional data?: object
      • Optional query?: URLSearchParams

    Returns Promise<T>

  • Get task info

    Parameters

    • id: string

      Task id

    Returns Promise<Task>

  • Get task stats

    Parameters

    • id: string

      Task id

    Returns Promise<TaskBtStats>

  • Get task list

    Parameters

    • id: string[] = []

      Task id, can be multiple

    • status: TaskStatus[] = []

      Filter by task status, can be multiple

    • notStatus: TaskStatus[] = []

      Filter by excluding task status, can be multiple

    Returns Promise<Task[]>

  • Parameters

    Returns undefined | URLSearchParams

  • Pause a task

    Parameters

    • id: string

      Task id

    Returns Promise<void>

  • Pause a batch of tasks

    Parameters

    • id: string[] = []

      Task id, can be multiple

    • status: TaskStatus[] = []

      Filter by task status, can be multiple

    • notStatus: TaskStatus[] = []

      Filter by excluding task status, can be multiple

    Returns Promise<void>

  • Resolve the download request

    Parameters

    • request: Request

      The request to create a new download task

    Returns Promise<ResolveResult>

Generated using TypeDoc