Class RTorrent

constructor

• new RTorrent(options?: Partial<RTorrentConfig>): RTorrent

  Parameters

  • options: Partial<RTorrentConfig> = {}

  Returns RTorrent

config

state

addMagnet

• addMagnet(
      magnetUrl: string,
      options?: Partial<AddTorrentOptions>,
  ): Promise<boolean>

  Parameters

  • magnetUrl: string
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<boolean>

addTorrent

• addTorrent(
      torrent: string | Uint8Array<ArrayBufferLike>,
      options?: Partial<AddTorrentOptions>,
  ): Promise<boolean>

  Parameters

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

  Returns Promise<boolean>

addTorrentFromFile

• addTorrentFromFile(
      fileContent: Uint8Array,
      options?: AddTorrentFileOptions,
  ): Promise<boolean>

  Add torrent from file https://github.com/rakshasa/rtorrent/wiki/Commands#load

  Parameters

  • fileContent: Uint8Array
  • options: AddTorrentFileOptions = {}

  Returns Promise<boolean>

addTorrentFromUrl

• addTorrentFromUrl(url: string, options?: AddTorrentUrlOptions): Promise<boolean>

  Add torrent from URL https://github.com/rakshasa/rtorrent/wiki/Commands#load

  Parameters

  • url: string
  • options: AddTorrentUrlOptions = {}

  Returns Promise<boolean>

addTorrentToView

• addTorrentToView(hash: string, view: string): Promise<boolean>

  Add torrent to view https://github.com/rakshasa/rtorrent/wiki/Commands#views

  Parameters

  • hash: string
  • view: string

  Returns Promise<boolean>

checkHash

• checkHash(hash: string): Promise<boolean>

  Recheck torrent data https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-d-check-hash

  Parameters

  • hash: string

  Returns Promise<boolean>

exportState

• exportState(): Jsonify<RTorrentState>

  Export the state of the client as JSON

  Returns Jsonify<RTorrentState>

getAllData

• getAllData(): Promise<AllClientData>

  Returns all torrent data. Data has been normalized

  Returns Promise<AllClientData>

getAllTorrents

• getAllTorrents(): Promise<RTorrentTorrent[]>

  Get all torrents with detailed information https://github.com/rakshasa/rtorrent/wiki/Commands#multicall

  Returns Promise<RTorrentTorrent[]>

getDownloadRateLimit

• getDownloadRateLimit(hash: string): Promise<number>

  Get the download limit in bytes/s of the torrent's throttle group. Torrents without a group use the global limit, 0 is unlimited and -1 means the group has no download limit. rTorrent has no per-torrent limits, torrents are assigned to named throttle groups instead. https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#throttle-commands

  Parameters

  • hash: string

  Returns Promise<number>

getGlobalDownloadRateLimit

• getGlobalDownloadRateLimit(): Promise<number>

  Get the global download limit in bytes/s, 0 is unlimited https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-throttle-global-down-max-rate

  Returns Promise<number>

getGlobalUploadRateLimit

• getGlobalUploadRateLimit(): Promise<number>

  Get the global upload limit in bytes/s, 0 is unlimited https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-throttle-global-up-max-rate

  Returns Promise<number>

getSystemInfo

• getSystemInfo(): Promise<RTorrentSystemInfo>

  Get rTorrent system information https://github.com/rakshasa/rtorrent/wiki/Commands#system

  Returns Promise<RTorrentSystemInfo>

getTorrent

• getTorrent(hash: string): Promise<NormalizedTorrent>

  Get torrent by hash (normalized format) https://github.com/rakshasa/rtorrent/wiki/Commands#multicall

  Parameters

  • hash: string

  Returns Promise<NormalizedTorrent>

getTorrentFiles

• getTorrentFiles(hash: string): Promise<RTorrentFile[]>

  Get torrent files https://github.com/rakshasa/rtorrent/wiki/Commands#files

  Parameters

  • hash: string

  Returns Promise<RTorrentFile[]>

getTorrentPeers

• getTorrentPeers(hash: string): Promise<RTorrentPeer[]>

  Get torrent peers https://github.com/rakshasa/rtorrent/wiki/Commands#peers

  Parameters

  • hash: string

  Returns Promise<RTorrentPeer[]>

getTorrentProperties

• getTorrentProperties(hash: string): Promise<Partial<RTorrentTorrent>>

  Get torrent properties https://github.com/rakshasa/rtorrent/wiki/Commands#multicall

  Parameters

  • hash: string

  Returns Promise<Partial<RTorrentTorrent>>

getTorrentRaw

• getTorrentRaw(hash: string): Promise<RTorrentTorrent | null>

  Get torrent by hash (raw rTorrent format) https://github.com/rakshasa/rtorrent/wiki/Commands#multicall

  Parameters

  • hash: string

  Returns Promise<RTorrentTorrent | null>

getTorrentTrackers

• getTorrentTrackers(hash: string): Promise<RTorrentTracker[]>

  Get torrent trackers https://github.com/rakshasa/rtorrent/wiki/Commands#trackers

  Parameters

  • hash: string

  Returns Promise<RTorrentTracker[]>

getUploadRateLimit

• getUploadRateLimit(hash: string): Promise<number>

  Get the upload limit in bytes/s of the torrent's throttle group. Torrents without a group use the global limit, 0 is unlimited and -1 means the group has no upload limit. https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#throttle-commands

  Parameters

  • hash: string

  Returns Promise<number>

getVersion

• getVersion(): Promise<string>

  Get rTorrent version https://github.com/rakshasa/rtorrent/wiki/Commands#system

  Returns Promise<string>

getViews

• getViews(): Promise<RTorrentView[]>

  Get available views https://github.com/rakshasa/rtorrent/wiki/Commands#views

  Returns Promise<RTorrentView[]>

hasTorrent

• hasTorrent(hash: string): Promise<boolean>

  Check if torrent exists https://github.com/rakshasa/rtorrent/wiki/Commands#name

  Parameters

  • hash: string

  Returns Promise<boolean>

normalizedAddTorrent

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

  Parameters

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

  Returns Promise<NormalizedTorrent>

pauseTorrent

• pauseTorrent(hash: string | string[]): Promise<void>

  Pause torrent with d.stop https://github.com/rakshasa/rtorrent/wiki/Commands#stop

  Parameters

  • hash: string | string[]

  Returns Promise<void>

queueDown

• queueDown(hash: string | string[]): 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

  • hash: string | string[]

  Returns Promise<void>

queueUp

• queueUp(hash: string | string[]): 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

  • hash: string | string[]

  Returns Promise<void>

removeTorrent

• removeTorrent(hash: string | string[], deleteFiles?: boolean): Promise<void>

  Remove torrent, throws when a torrent doesn't exist. Deleting files is not supported and throws https://github.com/rakshasa/rtorrent/wiki/Commands#erase

  Parameters

  • hash: string | string[]
  • deleteFiles: boolean = false

  Returns Promise<void>

removeTorrentFromView

• removeTorrentFromView(hash: string, view: string): Promise<boolean>

  Remove torrent from view https://github.com/rakshasa/rtorrent/wiki/Commands#views

  Parameters

  • hash: string
  • view: string

  Returns Promise<boolean>

resumeTorrent

• resumeTorrent(hash: string | string[]): Promise<void>

  Resumes stopped torrents and torrents paused with d.pause (ruTorrent's pause button). d.start does nothing for a paused torrent and d.resume does nothing for a stopped one. https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-d-resume

  Parameters

  • hash: string | string[]

  Returns Promise<void>

setFilePriority

• setFilePriority(
      hash: string,
      index: number,
      priority: RTorrentFilePriority,
  ): Promise<boolean>

  Set the priority of a file by its index in getTorrentFiles https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-f-priority-set

  Parameters

  • hash: string
  • index: number
  • priority: RTorrentFilePriority

  Returns Promise<boolean>

setGlobalDownloadRateLimit

• setGlobalDownloadRateLimit(bytesPerSecond: number): Promise<boolean>

  Set the global download limit in bytes/s, 0 is unlimited https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-throttle-global-down-max-rate

  Parameters

  • bytesPerSecond: number

  Returns Promise<boolean>

setGlobalUploadRateLimit

• setGlobalUploadRateLimit(bytesPerSecond: number): Promise<boolean>

  Set the global upload limit in bytes/s, 0 is unlimited https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-throttle-global-up-max-rate

  Parameters

  • bytesPerSecond: number

  Returns Promise<boolean>

setThrottleGroup

• setThrottleGroup(
      name: string,
      downKiB?: number,
      upKiB?: number,
  ): Promise<boolean>

  Create or update a named throttle group, limits are in KiB/s. Assign torrents to it with setTorrentThrottle https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-throttle-down

  Parameters

  • name: string
  • OptionaldownKiB: number
  • OptionalupKiB: number

  Returns Promise<boolean>

setTorrentLabel

• setTorrentLabel(hash: string, label: string): Promise<boolean>

  Set torrent label https://github.com/rakshasa/rtorrent/wiki/Commands#custom

  Parameters

  • hash: string
  • label: string

  Returns Promise<boolean>

setTorrentPriority

• setTorrentPriority(hash: string, priority: RTorrentPriority): Promise<boolean>

  Set torrent priority https://github.com/rakshasa/rtorrent/wiki/Commands#priority

  Parameters

  • hash: string
  • priority: RTorrentPriority

  Returns Promise<boolean>

setTorrentThrottle

• setTorrentThrottle(hash: string, name: string): Promise<boolean>

  Assign a torrent to a throttle group, an empty name removes it from its group. rTorrent only allows this while the torrent is stopped. https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-d-throttle-name-set

  Parameters

  • hash: string
  • name: string

  Returns Promise<boolean>

setTrackerEnabled

• setTrackerEnabled(
      hash: string,
      index: number,
      enabled: boolean,
  ): Promise<boolean>

  Enable or disable a tracker by its index in getTorrentTrackers https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html#term-t-is-enabled-set

  Parameters

  • hash: string
  • index: number
  • enabled: boolean

  Returns Promise<boolean>

startTorrent

• startTorrent(hash: string): Promise<boolean>

  Start torrent https://github.com/rakshasa/rtorrent/wiki/Commands#start

  Parameters

  • hash: string

  Returns Promise<boolean>

stopTorrent

• stopTorrent(hash: string): Promise<boolean>

  Stop torrent https://github.com/rakshasa/rtorrent/wiki/Commands#stop

  Parameters

  • hash: string

  Returns Promise<boolean>

StaticcreateFromState

• createFromState(
      config: Readonly<RTorrentConfig>,
      state: Readonly<Jsonify<RTorrentState>>,
  ): RTorrent

  Create a new RTorrent client from a state

  Parameters

  • config: Readonly<RTorrentConfig>
  • state: Readonly<Jsonify<RTorrentState>>

  Returns RTorrent