Class Transmission

constructor

• new Transmission(options?: Partial<TorrentClientConfig>): Transmission

  Parameters

  • options: Partial<TorrentClientConfig> = {}

  Returns Transmission

config

state

StaticcreateFromState

• createFromState(
      config: Readonly<TorrentClientConfig>,
      state: Readonly<Jsonify<TransmissionState>>,
  ): Transmission

  Parameters

  • config: Readonly<TorrentClientConfig>
  • state: Readonly<Jsonify<TransmissionState>>

  Returns Transmission

exportState

• exportState(): Jsonify<TransmissionState>

  Export the current state of the client. Can be restored with createFromState.

  Returns Jsonify<TransmissionState>

getSession

• getSession(): Promise<SessionResponse>

  Returns Promise<SessionResponse>

setSession

• setSession(args: Partial<SessionArguments>): Promise<SessionResponse>

  Parameters

  • args: Partial<SessionArguments>

  Returns Promise<SessionResponse>

queueTop

• queueTop(id: NormalizedTorrentIds): Promise<DefaultResponse>

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

queueBottom

• queueBottom(id: NormalizedTorrentIds): Promise<DefaultResponse>

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

queueUp

• queueUp(id: NormalizedTorrentIds): Promise<void>

  Move one or more torrents up the queue, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist, throws when the client has no queue

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<void>

queueDown

• queueDown(id: NormalizedTorrentIds): Promise<void>

  Move one or more torrents down the queue, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist, throws when the client has no queue

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<void>

freeSpace

• freeSpace(path?: string): Promise<FreeSpaceResponse>

  Parameters

  • path: string = '/downloads/complete'

  Returns Promise<FreeSpaceResponse>

pauseTorrent

• pauseTorrent(id: NormalizedTorrentIds): Promise<void>

  Pause one or more torrents, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<void>

resumeTorrent

• resumeTorrent(id: NormalizedTorrentIds): Promise<void>

  Resume one or more torrents, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<void>

verifyTorrent

• verifyTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

reannounceTorrent

• reannounceTorrent(id: NormalizedTorrentIds): Promise<DefaultResponse>

  ask tracker for more peers

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<DefaultResponse>

moveTorrent

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

  Parameters

  • id: NormalizedTorrentIds
  • location: string

  Returns Promise<DefaultResponse>

setTorrent

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

  Torrent Mutators

  Parameters

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

  Returns Promise<DefaultResponse>

renamePath

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

  Renaming a Torrent's Path

  Parameters

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

  Returns Promise<DefaultResponse>

removeTorrent

• removeTorrent(id: NormalizedTorrentIds, removeData?: boolean): Promise<void>

  Removing a Torrent

  Parameters

  • id: NormalizedTorrentIds
  • removeData: boolean = false

    (default: false) If true, remove the downloaded data.

  Returns Promise<void>

addUrl

• addUrl(
      ...args: [url: string, options: Partial<AddTorrentOptions>],
  ): Promise<AddTorrentResponse>

  An alias for Transmission.addMagnet

  Parameters

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

  Returns Promise<AddTorrentResponse>

addMagnet

• addMagnet(
      url: string,
      options?: Partial<AddTorrentOptions>,
  ): 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: string | Uint8Array<ArrayBuffer>,
      options?: Partial<AddTorrentOptions>,
  ): Promise<AddTorrentResponse>

  Adding a torrent

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>

    a stream of file content or contents of the file as base64 string

  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<AddTorrentResponse>

normalizedAddTorrent

• normalizedAddTorrent(
      torrent: string | Uint8Array<ArrayBuffer>,
      options?: Partial<NormalizedAddTorrentOptions>,
  ): Promise<NormalizedTorrent>

  Parameters

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

  Returns Promise<NormalizedTorrent>

getTorrent

• getTorrent(id: NormalizedTorrentIds): Promise<NormalizedTorrent>

  Throws a TorrentClientError with the torrent_not_found code when the torrent doesn't exist

  Parameters

  • id: NormalizedTorrentIds

  Returns Promise<NormalizedTorrent>

getAllData

• getAllData(): Promise<AllClientData>

  Returns all torrent data. Data has been normalized

  Returns Promise<AllClientData>

listTorrents

• listTorrents(
      id?: NormalizedTorrentIds,
      additionalFields?: string[],
  ): Promise<GetTorrentRepsonse>

  Parameters

  • Optionalid: NormalizedTorrentIds
  • additionalFields: string[] = []

  Returns Promise<GetTorrentRepsonse>

request

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

  Type Parameters

  • T

  Parameters

  • method: string
  • args: any = {}

  Returns Promise<Promise<FetchResponse<T>>>