Class Torrent

Hierarchy

Model
- Torrent

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Torrent(utorrent: uTorrent): Torrent

Inherited from Model.__constructor
- Defined in core/model.ts:8
Create the data manager

Parameters
- utorrent: uTorrent
Returns Torrent

Accessors

appUpdateUrl

get appUpdateUrl(): string

- Defined in models/torrent.ts:133
Get the app update URL (whatever that is...)

Returns string

availability

get availability(): number

- Defined in models/torrent.ts:140
Get the availability of the torrent (whatever that is as well)

Returns number

dateAdded

get dateAdded(): number

- Defined in models/torrent.ts:147
Get the date the torrent was added

Returns number

dateCompleted

get dateCompleted(): number

- Defined in models/torrent.ts:154
Get the date the torrent was completed

Returns number

downloadSpeed

get downloadSpeed(): number

- Defined in models/torrent.ts:168
The download speed (bytes per second)

Returns number

downloadUrl

get downloadUrl(): null | string

- Defined in models/torrent.ts:175
Get the download URL if it exists

Returns null | string

downloaded

get downloaded(): number

- Defined in models/torrent.ts:161
The amount of data downloaded (bytes)

Returns number

eta

get eta(): number

- Defined in models/torrent.ts:182
Get the estimated time remaining (seconds)

Returns number

files

get files(): undefined

- Defined in models/torrent.ts:189
Fetch the files associated with the torrent

Returns undefined

hash

get hash(): string

- Defined in models/torrent.ts:196
The torrent's hash

Returns string

label

get label(): null | string

- Defined in models/torrent.ts:203
The torrent's label if set

Returns null | string

name

get name(): string

- Defined in models/torrent.ts:210
The name of the torrent

Returns string

peersConnected

get peersConnected(): number

- Defined in models/torrent.ts:217
The number of peers connected

Returns number

peersInSwarm

get peersInSwarm(): number

- Defined in models/torrent.ts:224
The peers in the swarm

Returns number

progress

get progress(): number

- Defined in models/torrent.ts:231
The progress of the torrent

Returns number

queueOrder

get queueOrder(): number

- Defined in models/torrent.ts:238
The queue order of the torrent

Returns number

ratio

get ratio(): number

- Defined in models/torrent.ts:245
The upload/download ratio of the torrent

Returns number

rssFeedUrl

get rssFeedUrl(): string

- Defined in models/torrent.ts:252
The RSS feed URL

Returns string

seedsConnected

get seedsConnected(): number

- Defined in models/torrent.ts:259
The number of seeds connected

Returns number

seedsInSwarm

get seedsInSwarm(): number

- Defined in models/torrent.ts:266
The number of seeds in the swarm

Returns number

size

get size(): number

- Defined in models/torrent.ts:273
The total size of the files

Returns number

status

get status(): TorrentStatus

- Defined in models/torrent.ts:280
The status of the torrent

Returns TorrentStatus

statusMessage

get statusMessage(): string

- Defined in models/torrent.ts:287
The status message of the torrent

Returns string

streamId

get streamId(): string

- Defined in models/torrent.ts:294
The stream ID of the torrent

Returns string

uploadSpeed

get uploadSpeed(): number

- Defined in models/torrent.ts:308
The upload speed (bytes per second)

Returns number

uploaded

get uploaded(): number

- Defined in models/torrent.ts:301
The amount of data uploaded (bytes)

Returns number

Methods

pause

pause(): Promise<void>

- Defined in models/torrent.ts:76
Pause the torrent

Returns Promise<void>

refresh

refresh(): Promise<void>

- Defined in models/torrent.ts:83
Refresh the current torrent

Returns Promise<void>

remove

remove(flags?: RemoveFlag): Promise<void>

- Defined in models/torrent.ts:94
Remove the torrent from uTorrent

Parameters
- Default value flags: RemoveFlag = RemoveFlag.JobOnly
Returns Promise<void>

setData

setData(info: any): void

Overrides Model.setData
- Defined in models/torrent.ts:21
Update the corrent information

Parameters
- info: any
Returns void

start

start(force?: boolean): Promise<void>

- Defined in models/torrent.ts:110
Start the torrent

Parameters
- Default value force: boolean = false
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in models/torrent.ts:117
Stop the torrent

Returns Promise<void>

unpause

unpause(): Promise<void>

- Defined in models/torrent.ts:124
Unpause the torrent

Returns Promise<void>

Generated using TypeDoc