Interface TransmissionClient

Hierarchy

  • TransmissionClient

Implemented by

Properties

addMagnet: ((options) => Promise<{
    hashString: string;
    id: number;
    name: string;
}>)

Type declaration

    • (options): Promise<{
          hashString: string;
          id: number;
          name: string;
      }>
    • Parameters

      Returns Promise<{
          hashString: string;
          id: number;
          name: string;
      }>

getRecentlyActiveTorrents: ((config?) => Promise<GetRecentlyActiveTorrentsOutput>)

Type declaration

getSession: (() => Promise<{
    alt-speed-down: number;
    alt-speed-enabled: boolean;
    alt-speed-time-begin: number;
    alt-speed-time-day: number;
    alt-speed-time-enabled: boolean;
    alt-speed-time-end: number;
    alt-speed-up: number;
    blocklist-enabled: boolean;
    blocklist-size: number;
    blocklist-url: string;
    cache-size-mb: number;
    config-dir: string;
    dht-enabled: boolean;
    download-dir: string;
    download-dir-free-space: number;
    download-queue-enabled: boolean;
    download-queue-size: number;
    encryption: string;
    idle-seeding-limit: number;
    idle-seeding-limit-enabled: boolean;
    incomplete-dir: string;
    incomplete-dir-enabled: boolean;
    lpd-enabled: boolean;
    peer-limit-global: number;
    peer-limit-per-torrent: number;
    peer-port: number;
    peer-port-random-on-start: boolean;
    pex-enabled: boolean;
    port-forwarding-enabled: boolean;
    queue-stalled-enabled: boolean;
    queue-stalled-minutes: number;
    rename-partial-files: boolean;
    rpc-version: number;
    rpc-version-minimum: number;
    script-torrent-done-enabled: boolean;
    script-torrent-done-filename: string;
    seed-queue-enabled: boolean;
    seed-queue-size: number;
    seedRatioLimit: number;
    seedRatioLimited: boolean;
    session-id: string;
    speed-limit-down: number;
    speed-limit-down-enabled: boolean;
    speed-limit-up: number;
    speed-limit-up-enabled: boolean;
    start-added-torrents: boolean;
    trash-original-torrent-files: boolean;
    units: { 'memory-bytes': number; 'memory-units': string[]; 'size-bytes': number; 'size-units': string[]; 'speed-bytes': number; 'speed-units': string[]; };
    utp-enabled: boolean;
    version: string;
}>)

Type declaration

    • (): Promise<{
          alt-speed-down: number;
          alt-speed-enabled: boolean;
          alt-speed-time-begin: number;
          alt-speed-time-day: number;
          alt-speed-time-enabled: boolean;
          alt-speed-time-end: number;
          alt-speed-up: number;
          blocklist-enabled: boolean;
          blocklist-size: number;
          blocklist-url: string;
          cache-size-mb: number;
          config-dir: string;
          dht-enabled: boolean;
          download-dir: string;
          download-dir-free-space: number;
          download-queue-enabled: boolean;
          download-queue-size: number;
          encryption: string;
          idle-seeding-limit: number;
          idle-seeding-limit-enabled: boolean;
          incomplete-dir: string;
          incomplete-dir-enabled: boolean;
          lpd-enabled: boolean;
          peer-limit-global: number;
          peer-limit-per-torrent: number;
          peer-port: number;
          peer-port-random-on-start: boolean;
          pex-enabled: boolean;
          port-forwarding-enabled: boolean;
          queue-stalled-enabled: boolean;
          queue-stalled-minutes: number;
          rename-partial-files: boolean;
          rpc-version: number;
          rpc-version-minimum: number;
          script-torrent-done-enabled: boolean;
          script-torrent-done-filename: string;
          seed-queue-enabled: boolean;
          seed-queue-size: number;
          seedRatioLimit: number;
          seedRatioLimited: boolean;
          session-id: string;
          speed-limit-down: number;
          speed-limit-down-enabled: boolean;
          speed-limit-up: number;
          speed-limit-up-enabled: boolean;
          start-added-torrents: boolean;
          trash-original-torrent-files: boolean;
          units: { 'memory-bytes': number; 'memory-units': string[]; 'size-bytes': number; 'size-units': string[]; 'speed-bytes': number; 'speed-units': string[]; };
          utp-enabled: boolean;
          version: string;
      }>
    • Returns Promise<{
          alt-speed-down: number;
          alt-speed-enabled: boolean;
          alt-speed-time-begin: number;
          alt-speed-time-day: number;
          alt-speed-time-enabled: boolean;
          alt-speed-time-end: number;
          alt-speed-up: number;
          blocklist-enabled: boolean;
          blocklist-size: number;
          blocklist-url: string;
          cache-size-mb: number;
          config-dir: string;
          dht-enabled: boolean;
          download-dir: string;
          download-dir-free-space: number;
          download-queue-enabled: boolean;
          download-queue-size: number;
          encryption: string;
          idle-seeding-limit: number;
          idle-seeding-limit-enabled: boolean;
          incomplete-dir: string;
          incomplete-dir-enabled: boolean;
          lpd-enabled: boolean;
          peer-limit-global: number;
          peer-limit-per-torrent: number;
          peer-port: number;
          peer-port-random-on-start: boolean;
          pex-enabled: boolean;
          port-forwarding-enabled: boolean;
          queue-stalled-enabled: boolean;
          queue-stalled-minutes: number;
          rename-partial-files: boolean;
          rpc-version: number;
          rpc-version-minimum: number;
          script-torrent-done-enabled: boolean;
          script-torrent-done-filename: string;
          seed-queue-enabled: boolean;
          seed-queue-size: number;
          seedRatioLimit: number;
          seedRatioLimited: boolean;
          session-id: string;
          speed-limit-down: number;
          speed-limit-down-enabled: boolean;
          speed-limit-up: number;
          speed-limit-up-enabled: boolean;
          start-added-torrents: boolean;
          trash-original-torrent-files: boolean;
          units: { 'memory-bytes': number; 'memory-units': string[]; 'size-bytes': number; 'size-units': string[]; 'speed-bytes': number; 'speed-units': string[]; };
          utp-enabled: boolean;
          version: string;
      }>

listTorrents: ((config?) => Promise<{
    activityDate?: number;
    addedDate?: number;
    comment?: string;
    corruptEver?: number;
    creator?: string;
    desiredAvailable?: number;
    doneDate?: number;
    downloadDir?: string;
    downloadLimit?: number;
    downloadLimited?: boolean;
    downloadedEver?: number;
    error?: number;
    errorString?: string;
    eta?: number;
    etaIdle?: number;
    fileStats?: ({ bytesCompleted: number; priority: number; wanted: boolean; })[];
    files?: ({ name: string; length: number; bytesCompleted: number; })[];
    hashString?: string;
    haveUnchecked?: number;
    haveValid?: number;
    honorsSessionLimits?: boolean;
    id: number;
    isFinished?: boolean;
    isPrivate?: boolean;
    isStalled?: boolean;
    labels?: unknown[];
    leftUntilDone?: number;
    magnetLink?: string;
    manualAnnounceTime?: number;
    maxConnectedPeers?: number;
    metadataPercentComplete?: number;
    name?: string;
    peer-limit?: number;
    peers?: unknown[];
    peersConnected?: number;
    peersFrom?: { fromCache: number; fromDht: number; fromIncoming: number; fromLpd: number; fromLtep: number; fromPex: number; fromTracker: number; };
    peersGettingFromUs?: number;
    peersSendingToUs?: number;
    percentDone?: number;
    priorities?: number[];
    queuePosition?: number;
    rateDownload?: number;
    rateUpload?: number;
    recheckProgress?: number;
    secondsDownloading?: number;
    secondsSeeding?: number;
    seedIdleLimit?: number;
    seedRatioLimit?: number;
    seedRatioMode?: number;
    sizeWhenDone?: number;
    status?: "STOPPED" | "QUEUED_CHECK" | "CHECKING" | "QUEUED_DOWNLOAD" | "DOWNLOADING" | "QUEUED_SEED" | "SEEDING";
    totalSize?: number;
    trackers?: ({ id: number; announce: string; scrape: string; tier: number; })[];
    uploadRatio?: number;
    uploadedEver?: number;
    wanted?: number[];
    webseeds?: string[];
    webseedsSendingToUs?: number;
}[]>)

Type declaration

    • (config?): Promise<{
          activityDate?: number;
          addedDate?: number;
          comment?: string;
          corruptEver?: number;
          creator?: string;
          desiredAvailable?: number;
          doneDate?: number;
          downloadDir?: string;
          downloadLimit?: number;
          downloadLimited?: boolean;
          downloadedEver?: number;
          error?: number;
          errorString?: string;
          eta?: number;
          etaIdle?: number;
          fileStats?: ({ bytesCompleted: number; priority: number; wanted: boolean; })[];
          files?: ({ name: string; length: number; bytesCompleted: number; })[];
          hashString?: string;
          haveUnchecked?: number;
          haveValid?: number;
          honorsSessionLimits?: boolean;
          id: number;
          isFinished?: boolean;
          isPrivate?: boolean;
          isStalled?: boolean;
          labels?: unknown[];
          leftUntilDone?: number;
          magnetLink?: string;
          manualAnnounceTime?: number;
          maxConnectedPeers?: number;
          metadataPercentComplete?: number;
          name?: string;
          peer-limit?: number;
          peers?: unknown[];
          peersConnected?: number;
          peersFrom?: { fromCache: number; fromDht: number; fromIncoming: number; fromLpd: number; fromLtep: number; fromPex: number; fromTracker: number; };
          peersGettingFromUs?: number;
          peersSendingToUs?: number;
          percentDone?: number;
          priorities?: number[];
          queuePosition?: number;
          rateDownload?: number;
          rateUpload?: number;
          recheckProgress?: number;
          secondsDownloading?: number;
          secondsSeeding?: number;
          seedIdleLimit?: number;
          seedRatioLimit?: number;
          seedRatioMode?: number;
          sizeWhenDone?: number;
          status?: "STOPPED" | "QUEUED_CHECK" | "CHECKING" | "QUEUED_DOWNLOAD" | "DOWNLOADING" | "QUEUED_SEED" | "SEEDING";
          totalSize?: number;
          trackers?: ({ id: number; announce: string; scrape: string; tier: number; })[];
          uploadRatio?: number;
          uploadedEver?: number;
          wanted?: number[];
          webseeds?: string[];
          webseedsSendingToUs?: number;
      }[]>
    • Parameters

      Returns Promise<{
          activityDate?: number;
          addedDate?: number;
          comment?: string;
          corruptEver?: number;
          creator?: string;
          desiredAvailable?: number;
          doneDate?: number;
          downloadDir?: string;
          downloadLimit?: number;
          downloadLimited?: boolean;
          downloadedEver?: number;
          error?: number;
          errorString?: string;
          eta?: number;
          etaIdle?: number;
          fileStats?: ({ bytesCompleted: number; priority: number; wanted: boolean; })[];
          files?: ({ name: string; length: number; bytesCompleted: number; })[];
          hashString?: string;
          haveUnchecked?: number;
          haveValid?: number;
          honorsSessionLimits?: boolean;
          id: number;
          isFinished?: boolean;
          isPrivate?: boolean;
          isStalled?: boolean;
          labels?: unknown[];
          leftUntilDone?: number;
          magnetLink?: string;
          manualAnnounceTime?: number;
          maxConnectedPeers?: number;
          metadataPercentComplete?: number;
          name?: string;
          peer-limit?: number;
          peers?: unknown[];
          peersConnected?: number;
          peersFrom?: { fromCache: number; fromDht: number; fromIncoming: number; fromLpd: number; fromLtep: number; fromPex: number; fromTracker: number; };
          peersGettingFromUs?: number;
          peersSendingToUs?: number;
          percentDone?: number;
          priorities?: number[];
          queuePosition?: number;
          rateDownload?: number;
          rateUpload?: number;
          recheckProgress?: number;
          secondsDownloading?: number;
          secondsSeeding?: number;
          seedIdleLimit?: number;
          seedRatioLimit?: number;
          seedRatioMode?: number;
          sizeWhenDone?: number;
          status?: "STOPPED" | "QUEUED_CHECK" | "CHECKING" | "QUEUED_DOWNLOAD" | "DOWNLOADING" | "QUEUED_SEED" | "SEEDING";
          totalSize?: number;
          trackers?: ({ id: number; announce: string; scrape: string; tier: number; })[];
          uploadRatio?: number;
          uploadedEver?: number;
          wanted?: number[];
          webseeds?: string[];
          webseedsSendingToUs?: number;
      }[]>

ping: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

removeTorrents: ((config) => Promise<void>)

Type declaration

Generated using TypeDoc