Class Utorrent

constructor

• new Utorrent(options?: Partial<TorrentSettings>): Utorrent

  Parameters

  • options: Partial<TorrentSettings> = {}

  Returns Utorrent

config

state

addTorrent

• addTorrent(torrent: string | Uint8Array<ArrayBuffer>): Promise<BaseResponse>

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>

  Returns Promise<BaseResponse>

addTorrentFromUrl

• addTorrentFromUrl(urlOrMagnet: string): Promise<BaseResponse>

  Add torrent from url, probably a magnet

  Parameters

  • urlOrMagnet: string

  Returns Promise<BaseResponse>

connect

• connect(): Promise<void>

  Returns Promise<void>

exportState

• exportState(): Jsonify<UtorrentState>

  Export the state of the client as JSON

  Returns Jsonify<UtorrentState>

forceStartTorrent

• forceStartTorrent(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

getAllData

• getAllData(): Promise<AllClientData>

  Returns all torrent data. Data has been normalized

  Returns Promise<AllClientData>

getSettings

• getSettings(): Promise<SettingsResponse>

  Returns Promise<SettingsResponse>

getTorrent

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

  Parameters

  • id: string

  Returns Promise<NormalizedTorrent>

getVersion

• getVersion(): Promise<VersionResponse>

  Returns Promise<VersionResponse>

listTorrents

• listTorrents(): Promise<TorrentListResponse>

  Returns Promise<TorrentListResponse>

logout

• logout(): boolean

  Returns boolean

normalizedAddTorrent

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

  Parameters

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

  Returns Promise<NormalizedTorrent>

pauseTorrent

• pauseTorrent(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueBottom

• queueBottom(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueDown

• queueDown(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueTop

• queueTop(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueUp

• queueUp(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

removeTorrent

• removeTorrent(hash: string, removeData?: boolean): Promise<BaseResponse>

  Parameters

  • hash: string
  • removeData: boolean = false

    (default: false) If true, remove the data from disk

  Returns Promise<BaseResponse>

request

• request<T extends object>(
      action: string,
      params?: URLSearchParams,
  ): Promise<Promise<FetchResponse<T>>>

  Type Parameters

  • T extends object

  Parameters

  • action: string
  • params: URLSearchParams = ...

  Returns Promise<Promise<FetchResponse<T>>>

resetSession

• resetSession(): void

  Returns void

resumeTorrent

• resumeTorrent(hash: string): Promise<BaseResponse>

  alias of unpause, resumes a torrent

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

rssRemove

• rssRemove(id: number): Promise<BaseResponse>

  Parameters

  • id: number

  Returns Promise<BaseResponse>

rssUpdate

• rssUpdate(
      url: string,
      id?: number,
      alias?: string,
      subscribe?: boolean,
      smartFilter?: boolean,
      enabled?: boolean,
  ): Promise<RssUpdateResponse>

  subscribe to rss feed

  Parameters

  • url: string

    feed url
  • Optionalid: number = -1

    id of rss feed to update, -1 for new feed
  • Optionalalias: string = ''

    custom alias
  • Optionalsubscribe: boolean = false

    Automatically download all items published in feed
  • OptionalsmartFilter: boolean = false

    Use smart episode filter
  • Optionalenabled: boolean = true

    disable / enable an rss feed

  Returns Promise<RssUpdateResponse>

setProps

• setProps(
      hash: string,
      props: Record<string, string | number>,
  ): Promise<BaseResponse>

  Parameters

  • hash: string
  • props: Record<string, string | number>

  Returns Promise<BaseResponse>

setSetting

• setSetting(settings: [string, string | number][]): Promise<BaseResponse>

  set a setting

  Parameters

  • settings: [string, string | number][]

    settings to set [setting_name, value] as array of key value tuples

  Returns Promise<BaseResponse>

stopTorrent

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

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

unpause

• unpause(hash: string): Promise<BaseResponse>

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

StaticcreateFromState

• createFromState(
      config: Readonly<TorrentSettings>,
      state: Readonly<Jsonify<UtorrentState>>,
  ): Utorrent

  Create a new Utorrent client from a previously exported state

  Parameters

  • config: Readonly<TorrentSettings>
  • state: Readonly<Jsonify<UtorrentState>>

  Returns Utorrent