Class Transmission

constructor

• new Transmission(options?): Transmission

• Parameters

  • options: Partial<TorrentSettings> = {}

  Returns Transmission

config

Optional sessionId

getSession

• getSession(): Promise<SessionResponse>

• Returns Promise<SessionResponse>

setSession

• setSession(args): Promise<SessionResponse>

• Parameters

  • args: Partial<SessionArguments>

  Returns Promise<SessionResponse>

queueTop

• queueTop(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

queueBottom

• queueBottom(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

queueUp

• queueUp(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

queueDown

• queueDown(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

freeSpace

• freeSpace(path?): Promise<FreeSpaceResponse>

• Parameters

  • path: string = '/downloads/complete'

  Returns Promise<FreeSpaceResponse>

pauseTorrent

• pauseTorrent(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

resumeTorrent

• resumeTorrent(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

verifyTorrent

• verifyTorrent(id): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

reannounceTorrent

• reannounceTorrent(id): Promise<DefaultResponse>

• ask tracker for more peers

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

moveTorrent

• moveTorrent(id, location): Promise<DefaultResponse>

• Parameters

  • id: NormalizedTorrentIds
  • location: string

  Returns Promise<DefaultResponse>

setTorrent

• setTorrent(id, options?): Promise<DefaultResponse>

• Torrent Mutators

  Parameters

  • id: NormalizedTorrentIds
  • options: Partial<SetTorrentOptions> = {}

  Returns Promise<DefaultResponse>

renamePath

• renamePath(id, options?): Promise<DefaultResponse>

• Renaming a Torrent's Path

  Parameters

  • id: NormalizedTorrentIds
  • options: Partial<RenamePathOptions> = {}

  Returns Promise<DefaultResponse>

removeTorrent

• removeTorrent(id, removeData?): Promise<AddTorrentResponse>

• Removing a Torrent

  Parameters

  • id: NormalizedTorrentIds
  • removeData: boolean = true

  Returns Promise<AddTorrentResponse>

addUrl

• addUrl(...args): Promise<AddTorrentResponse>

• An alias for Transmission.addMagnet

  Parameters

  • Rest ...args: [url: string, options: Partial<AddTorrentOptions>]

  Returns Promise<AddTorrentResponse>

addMagnet

• addMagnet(url, options?): Promise<AddTorrentResponse>

• note: This is the same "torrent-add" action with different options, less confusing to add it as its own method

  Parameters

  • url: string

    magnet link
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<AddTorrentResponse>

addTorrent

• addTorrent(torrent, options?): Promise<AddTorrentResponse>

• Adding a torrent

  Parameters

  • torrent: string | Uint8Array

    a string of file path or contents of the file as base64 string
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<AddTorrentResponse>

normalizedAddTorrent

• normalizedAddTorrent(torrent, options?): Promise<NormalizedTorrent>

• Parameters

  • torrent: string | Uint8Array
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<NormalizedTorrent>

getTorrent

• getTorrent(id): Promise<NormalizedTorrent>

• Parameters

  • id: NormalizedTorrentIds

  Returns Promise<NormalizedTorrent>

getAllData

• getAllData(): Promise<AllClientData>

• Returns Promise<AllClientData>

listTorrents

• listTorrents(id?, additionalFields?): Promise<GetTorrentRepsonse>

• Parameters

  • Optional id: NormalizedTorrentIds
  • additionalFields: string[] = []

  Returns Promise<GetTorrentRepsonse>

request

• request<T>(method, args?): Promise<FetchResponse<T>>

• Type Parameters

  • T

  Parameters

  • method: string
  • args: any = {}

  Returns Promise<FetchResponse<T>>