Class Utorrent

Hierarchy

Utorrent

Implements

TorrentClient

Index

Constructors

constructor

Properties

config

Constructors

constructor

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

- Defined in index.ts:41
Parameters
- options: Partial<TorrentSettings> = {}
Returns Utorrent

Properties

config

config: TorrentSettings

Methods

addTorrent

addTorrent(torrent: string | Buffer): Promise<BaseResponse>

Implementation of TorrentClient.addTorrent
- Defined in index.ts:210
Parameters
- torrent: string | Buffer
Returns Promise<BaseResponse>

connect

connect(): Promise<void>

- Defined in index.ts:321
Returns Promise<void>

forceStartTorrent

forceStartTorrent(hash: string): Promise<BaseResponse>

- Defined in index.ts:76
Parameters
- hash: string
Returns Promise<BaseResponse>

getAllData

getAllData(): Promise<AllClientData>

Implementation of TorrentClient.getAllData
- Defined in index.ts:187
Returns Promise<AllClientData>

getSettings

getSettings(): Promise<SettingsResponse>

- Defined in index.ts:52
Returns Promise<SettingsResponse>

getTorrent

getTorrent(id: string): Promise<NormalizedTorrent>

Implementation of TorrentClient.getTorrent
- Defined in index.ts:177
Parameters
- id: string
Returns Promise<NormalizedTorrent>

getVersion

getVersion(): Promise<VersionResponse>

- Defined in index.ts:57
Returns Promise<VersionResponse>

listTorrents

listTorrents(): Promise<TorrentListResponse>

- Defined in index.ts:314
Returns Promise<TorrentListResponse>

normalizedAddTorrent

normalizedAddTorrent(torrent: string | Buffer, options?: Partial<AddTorrentOptions>): Promise<NormalizedTorrent>

Implementation of TorrentClient.normalizedAddTorrent
- Defined in index.ts:151
Parameters
- torrent: string | Buffer
- options: Partial<AddTorrentOptions> = {}
Returns Promise<NormalizedTorrent>

pauseTorrent

pauseTorrent(hash: string): Promise<BaseResponse>

Implementation of TorrentClient.pauseTorrent
- Defined in index.ts:83
Parameters
- hash: string
Returns Promise<BaseResponse>

queueBottom

queueBottom(hash: string): Promise<BaseResponse>

- Defined in index.ts:118
Parameters
- hash: string
Returns Promise<BaseResponse>

queueDown

queueDown(hash: string): Promise<BaseResponse>

Implementation of TorrentClient.queueDown
- Defined in index.ts:104
Parameters
- hash: string
Returns Promise<BaseResponse>

queueTop

queueTop(hash: string): Promise<BaseResponse>

- Defined in index.ts:111
Parameters
- hash: string
Returns Promise<BaseResponse>

queueUp

queueUp(hash: string): Promise<BaseResponse>

Implementation of TorrentClient.queueUp
- Defined in index.ts:97
Parameters
- hash: string
Returns Promise<BaseResponse>

removeTorrent

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

Implementation of TorrentClient.removeTorrent
- Defined in index.ts:125
Parameters
- hash: string
- removeData: boolean = true
Returns Promise<BaseResponse>

request

request<T>(action: string, params?: URLSearchParams): Promise<Response<T>>

- Defined in index.ts:358
Type parameters
- T: object
Parameters
- action: string
- params: URLSearchParams = ...
Returns Promise<Response<T>>

resetSession

resetSession(): void

- Defined in index.ts:47
Returns void

resumeTorrent

resumeTorrent(hash: string): Promise<BaseResponse>

Implementation of TorrentClient.resumeTorrent
- Defined in index.ts:65
alias of unpause, resumes a torrent

Parameters
- hash: string
Returns Promise<BaseResponse>

rssRemove

rssRemove(id: number): Promise<BaseResponse>

- Defined in index.ts:307
Parameters
- id: number
Returns Promise<BaseResponse>

rssUpdate

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

- Defined in index.ts:288
subscribe to rss feed

Parameters
- url: string
  
  feed url
- id: number = -1
  
  of rss feed to update, -1 for new feed
- alias: string = ''
- subscribe: boolean = false
- smartFilter: boolean = false
- enabled: boolean = true
Returns Promise<RssUpdateResponse>

setProps

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

- Defined in index.ts:139
Parameters
- hash: string
- props: Record<string, string | number>
Returns Promise<BaseResponse>

setSetting

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

- Defined in index.ts:267
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>

- Defined in index.ts:90
Parameters
- hash: string
Returns Promise<BaseResponse>

unpause

unpause(hash: string): Promise<BaseResponse>

- Defined in index.ts:69
Parameters
- hash: string
Returns Promise<BaseResponse>