Class Deluge

Hierarchy

Deluge

Implements

TorrentClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in index.ts:51
Parameters
- Default value options: Partial<TorrentSettings> = {}
Returns Deluge

Properties

Private Optional _cookie

_cookie: Cookie

Private _msgId

_msgId: number = 0

config

config: TorrentSettings

Methods

Private _normalizeTorrentData

_normalizeTorrentData(id: string, torrent: Torrent): NormalizedTorrent

- Defined in index.ts:646
Parameters
- id: string
- torrent: Torrent
Returns NormalizedTorrent

Private _validateAuth

_validateAuth(): Promise<void>

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

addLabel

addLabel(label: string): Promise<DefaultResponse>

- Defined in index.ts:532
Parameters
- label: string
Returns Promise<DefaultResponse>

addTorrent

addTorrent(torrent: string | Buffer, config?: Partial<AddTorrentOptions>): Promise<AddTorrentResponse>

- Defined in index.ts:236
Parameters
- torrent: string | Buffer
- Default value config: Partial<AddTorrentOptions> = {}
Returns Promise<AddTorrentResponse>

addTorrentMagnet

addTorrentMagnet(magnet: string, config?: Partial<AddTorrentOptions>): Promise<BooleanStatus>

- Defined in index.ts:299
Parameters
- magnet: string
- Default value config: Partial<AddTorrentOptions> = {}
Returns Promise<BooleanStatus>

changePassword

changePassword(password: string): Promise<BooleanStatus>

- Defined in index.ts:337
Parameters
- password: string
Returns Promise<BooleanStatus>

checkSession

checkSession(): Promise<boolean>

- Defined in index.ts:125
Checks current session is valid

Returns Promise<boolean>

true if valid

connect

connect(selectedHost?: undefined | string, hostIdx?: number): Promise<ListMethods>

- Defined in index.ts:86
Connects deluge and returns a list of available methods

Parameters
- Optional selectedHost: undefined | string
- Default value hostIdx: number = 0
  
  index of host to use in result of get hosts
Returns Promise<ListMethods>

connected

connected(): Promise<boolean>

- Defined in index.ts:101
Returns Promise<boolean>

disablePlugin

disablePlugin(plugins: string[]): Promise<DefaultResponse>

- Defined in index.ts:592
Parameters
- plugins: string[]
Returns Promise<DefaultResponse>

disconnect

disconnect(): Promise<boolean>

- Defined in index.ts:110
Disconnects deluge - warning all instances connected to this client will also be disconnected. Other instances may also reconnect. Not really sure why you would want to disconnect

Returns Promise<boolean>

enablePlugin

enablePlugin(plugins: string[]): Promise<DefaultResponse>

- Defined in index.ts:587
Parameters
- plugins: string[]
Returns Promise<DefaultResponse>

getAllData

getAllData(): Promise<AllClientData>

- Defined in index.ts:352
Returns Promise<AllClientData>

getConfig

getConfig(): Promise<ConfigResponse>

- Defined in index.ts:567
Returns Promise<ConfigResponse>

getHostStatus

getHostStatus(host: string): Promise<GetHostStatusResponse>

- Defined in index.ts:71
Gets host status

Parameters
- host: string
  
  pass host id from this.getHosts()
Returns Promise<GetHostStatusResponse>

getHosts

getHosts(): Promise<GetHostsResponse>

- Defined in index.ts:62
Returns Promise<GetHostsResponse>

getLabels

getLabels(): Promise<ListMethods>

- Defined in index.ts:542
Returns Promise<ListMethods>

getPluginInfo

getPluginInfo(plugins: string[]): Promise<PluginInfo>

- Defined in index.ts:582
Parameters
- plugins: string[]
Returns Promise<PluginInfo>

getPlugins

getPlugins(): Promise<PluginsListResponse>

- Defined in index.ts:577
Returns Promise<PluginsListResponse>

getTorrent

getTorrent(id: string): Promise<NormalizedTorrent>

- Defined in index.ts:416
Parameters
- id: string
Returns Promise<NormalizedTorrent>

getTorrentFiles

getTorrentFiles(torrentId: string): Promise<TorrentFiles>

- Defined in index.ts:483
Get list of files for a torrent

Parameters
- torrentId: string
Returns Promise<TorrentFiles>

getTorrentInfo

getTorrentInfo(tmpPath: string): Promise<TorrentInfo>

- Defined in index.ts:189
used to get torrent info before adding

Parameters
- tmpPath: string
  
  use path returned from upload torrent looks like '/tmp/delugeweb-DfEsgR/tmpD3rujY.torrent'
Returns Promise<TorrentInfo>

getTorrentStatus

getTorrentStatus(torrentId: string, additionalFields?: string[]): Promise<TorrentStatus>

- Defined in index.ts:425
get torrent state/status

Parameters
- torrentId: string
- Default value additionalFields: string[] = []
  
  fields ex - ['label']
Returns Promise<TorrentStatus>

getVersion

getVersion(): Promise<StringStatus>

- Defined in index.ts:180
returns the version ex - 2.0.3-2-201906121747-ubuntu18.04.1

Returns Promise<StringStatus>

listMethods

listMethods(auth?: boolean): Promise<ListMethods>

- Defined in index.ts:199
Lists methods

Parameters
- Default value auth: boolean = true
  
  disable or enable auth connection
Returns Promise<ListMethods>

a list of method names

listTorrents

listTorrents(additionalFields?: string[], filter?: {}): Promise<TorrentListResponse>

- Defined in index.ts:377
Parameters
- Default value additionalFields: string[] = []
- Default value filter: {} = {}
  - [key: string]: string
Returns Promise<TorrentListResponse>

login

login(): Promise<boolean>

- Defined in index.ts:156
Login deluge

Returns Promise<boolean>

true if success

logout

logout(): Promise<boolean>

- Defined in index.ts:171
Logout deluge

Returns Promise<boolean>

true if success

normalizedAddTorrent

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

- Defined in index.ts:274
Parameters
- torrent: string | Buffer
- Default value options: Partial<NormalizedAddTorrentOptions> = {}
Returns Promise<NormalizedTorrent>

pauseTorrent

pauseTorrent(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:488
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueBottom

queueBottom(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:552
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueDown

queueDown(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:562
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueTop

queueTop(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:547
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueUp

queueUp(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:557
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

removeLabel

removeLabel(label: string): Promise<DefaultResponse>

- Defined in index.ts:537
Parameters
- label: string
Returns Promise<DefaultResponse>

removeTorrent

removeTorrent(torrentId: string, removeData?: boolean): Promise<BooleanStatus>

- Defined in index.ts:332
Parameters
- torrentId: string
  
  torrent id from list torrents
- Default value removeData: boolean = true
  
  true will delete all data from disk
Returns Promise<BooleanStatus>

request

request<T>(method: string, params?: any[], needsAuth?: boolean, autoConnect?: boolean): Promise<Response<T>>

- Defined in index.ts:598
Type parameters
- T: object
Parameters
- method: string
- Default value params: any[] = []
- Default value needsAuth: boolean = true
- Default value autoConnect: boolean = true
Returns Promise<Response<T>>

resetSession

resetSession(): void

- Defined in index.ts:57
Returns void

resumeTorrent

resumeTorrent(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:493
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

setConfig

setConfig(config: Partial<DelugeSettings>): Promise<DefaultResponse>

- Defined in index.ts:572
Parameters
- config: Partial<DelugeSettings>
Returns Promise<DefaultResponse>

setTorrentLabel

setTorrentLabel(torrentId: string, label: string): Promise<DefaultResponse>

- Defined in index.ts:527
Parameters
- torrentId: string
- label: string
Returns Promise<DefaultResponse>

setTorrentOptions

setTorrentOptions(torrentId: string, options?: Partial<TorrentOptions>): Promise<DefaultResponse>

- Defined in index.ts:498
Parameters
- torrentId: string
- Default value options: Partial<TorrentOptions> = {}
Returns Promise<DefaultResponse>

setTorrentTrackers

setTorrentTrackers(torrentId: string, trackers?: Tracker[]): Promise<DefaultResponse>

- Defined in index.ts:509
Parameters
- torrentId: string
- Default value trackers: Tracker[] = []
Returns Promise<DefaultResponse>

updateTorrentTrackers

updateTorrentTrackers(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:517
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

upload

upload(torrent: string | Buffer): Promise<UploadResponse>

- Defined in index.ts:204
Parameters
- torrent: string | Buffer
Returns Promise<UploadResponse>

verifyTorrent

verifyTorrent(torrentId: string): Promise<DefaultResponse>

- Defined in index.ts:522
Parameters
- torrentId: string
Returns Promise<DefaultResponse>