Class Utorrent

constructor

• new Utorrent(options?): Utorrent

• Parameters

  • options: Partial<TorrentSettings> = {}

  Returns Utorrent

config

addTorrent

• addTorrent(torrent): Promise<BaseResponse>

• Parameters

  • torrent: string | Buffer

  Returns Promise<BaseResponse>

addTorrentFromUrl

• addTorrentFromUrl(urlOrMagnet): Promise<BaseResponse>

• Add torrent from url, probably a magnet

  Parameters

  • urlOrMagnet: string

  Returns Promise<BaseResponse>

connect

• connect(): Promise<void>

• Returns Promise<void>

forceStartTorrent

• forceStartTorrent(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

getAllData

• getAllData(): Promise<AllClientData>

• Returns Promise<AllClientData>

getSettings

• getSettings(): Promise<SettingsResponse>

• Returns Promise<SettingsResponse>

getTorrent

• getTorrent(id): Promise<NormalizedTorrent>

• Parameters

  • id: string

  Returns Promise<NormalizedTorrent>

getVersion

• getVersion(): Promise<VersionResponse>

• Returns Promise<VersionResponse>

listTorrents

• listTorrents(): Promise<TorrentListResponse>

• Returns Promise<TorrentListResponse>

normalizedAddTorrent

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

• Parameters

  • torrent: string | Buffer

  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<NormalizedTorrent>

pauseTorrent

• pauseTorrent(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueBottom

• queueBottom(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueDown

• queueDown(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueTop

• queueTop(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

queueUp

• queueUp(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

removeTorrent

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

• Parameters

  • hash: string

  • removeData: boolean = true

  Returns Promise<BaseResponse>

request

• request<T>(action, params?): Promise<FetchResponse<T>>

• Type Parameters

  • T extends object

  Parameters

  • action: string

  • params: URLSearchParams = ...

  Returns Promise<FetchResponse<T>>

resetSession

• resetSession(): void

• Returns void

resumeTorrent

• resumeTorrent(hash): Promise<BaseResponse>

• alias of unpause, resumes a torrent

  Parameters

  • hash: string

  Returns Promise<BaseResponse>

rssRemove

• rssRemove(id): Promise<BaseResponse>

• Parameters

  • id: number

  Returns Promise<BaseResponse>

rssUpdate

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

• subscribe to rss feed

  Parameters

  • url: string

    feed url

  • Optional id: number = -1

    id of rss feed to update, -1 for new feed

  • Optional alias: string = ''

    custom alias

  • Optional subscribe: boolean = false

    Automatically download all items published in feed

  • Optional smartFilter: boolean = false

    Use smart episode filter

  • Optional enabled: boolean = true

    disable / enable an rss feed

  Returns Promise<RssUpdateResponse>

setProps

• setProps(hash, props): Promise<BaseResponse>

• Parameters

  • hash: string

  • props: Record<string, string | number>

  Returns Promise<BaseResponse>

setSetting

• setSetting(settings): 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): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>

unpause

• unpause(hash): Promise<BaseResponse>

• Parameters

  • hash: string

  Returns Promise<BaseResponse>