Class Deluge

Hierarchy

Deluge

Implements

TorrentClient

Constructors

constructor

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

- Defined in deluge.ts:56
Parameters
- options: Partial<TorrentSettings> = {}
Returns Deluge

Properties

config

config: TorrentSettings

Methods

addLabel

addLabel(label: string): Promise<DefaultResponse>

- Defined in deluge.ts:570
Parameters
- label: string
Returns Promise<DefaultResponse>

addTorrent

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

Implementation of TorrentClient.addTorrent
- Defined in deluge.ts:257
Parameters
- torrent: string | Buffer
- config: Partial<AddTorrentOptions> = {}
Returns Promise<AddTorrentResponse>

addTorrentMagnet

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

- Defined in deluge.ts:337
Parameters
- magnet: string
- config: Partial<AddTorrentOptions> = {}
Returns Promise<BooleanStatus>

changePassword

changePassword(password: string): Promise<BooleanStatus>

- Defined in deluge.ts:375
Parameters
- password: string
Returns Promise<BooleanStatus>

checkSession

checkSession(): Promise<boolean>

- Defined in deluge.ts:128
Checks current session is valid

Returns Promise<boolean>
true if valid

connect

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

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

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

connected

connected(): Promise<boolean>

- Defined in deluge.ts:104
Returns Promise<boolean>

disablePlugin

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

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

disconnect

disconnect(): Promise<boolean>

- Defined in deluge.ts:113
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>

downloadFromUrl

downloadFromUrl(url: string, cookies?: string): Promise<string>

- Defined in deluge.ts:247
Download a torrent from url, pass the result to Deluge.addTorrent

Parameters
- url: string
- cookies: string = ''
Returns Promise<string>
file path

enablePlugin

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

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

getAllData

getAllData(): Promise<AllClientData>

Implementation of TorrentClient.getAllData
- Defined in deluge.ts:390
Returns Promise<AllClientData>

getConfig

getConfig(): Promise<ConfigResponse>

- Defined in deluge.ts:605
Returns Promise<ConfigResponse>

getHostStatus

getHostStatus(host: string): Promise<GetHostStatusResponse>

- Defined in deluge.ts:74
Gets host status

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

getHosts

getHosts(): Promise<GetHostsResponse>

- Defined in deluge.ts:65
Returns Promise<GetHostsResponse>

getLabels

getLabels(): Promise<ListMethods>

- Defined in deluge.ts:580
Returns Promise<ListMethods>

getPluginInfo

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

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

getPlugins

getPlugins(): Promise<PluginsListResponse>

- Defined in deluge.ts:615
Returns Promise<PluginsListResponse>

getTorrent

getTorrent(id: string): Promise<NormalizedTorrent>

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

getTorrentFiles

getTorrentFiles(torrentId: string): Promise<TorrentFiles>

- Defined in deluge.ts:521
Get list of files for a torrent

Parameters
- torrentId: string
Returns Promise<TorrentFiles>

getTorrentInfo

getTorrentInfo(tmpPath: string): Promise<TorrentInfo>

- Defined in deluge.ts:192
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 deluge.ts:463
get torrent state/status

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

getVersion

getVersion(): Promise<StringStatus>

- Defined in deluge.ts:183
returns the version ex - 2.0.3-2-201906121747-ubuntu18.04.1

Returns Promise<StringStatus>

listMethods

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

- Defined in deluge.ts:202
Lists methods

Parameters
- auth: boolean = true
  
  disable or enable auth connection
Returns Promise<ListMethods>
a list of method names

listTorrents

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

- Defined in deluge.ts:415
Parameters
- additionalFields: string[] = []
- filter: Record<string, string> = {}
Returns Promise<TorrentListResponse>

login

login(): Promise<boolean>

- Defined in deluge.ts:159
Login deluge

Returns Promise<boolean>
true if success

logout

logout(): Promise<boolean>

- Defined in deluge.ts:174
Logout deluge

Returns Promise<boolean>
true if success

normalizedAddTorrent

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

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

pauseTorrent

pauseTorrent(torrentId: string): Promise<DefaultResponse>

Implementation of TorrentClient.pauseTorrent
- Defined in deluge.ts:526
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueBottom

queueBottom(torrentId: string): Promise<DefaultResponse>

- Defined in deluge.ts:590
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueDown

queueDown(torrentId: string): Promise<DefaultResponse>

Implementation of TorrentClient.queueDown
- Defined in deluge.ts:600
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueTop

queueTop(torrentId: string): Promise<DefaultResponse>

- Defined in deluge.ts:585
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

queueUp

queueUp(torrentId: string): Promise<DefaultResponse>

Implementation of TorrentClient.queueUp
- Defined in deluge.ts:595
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

removeLabel

removeLabel(label: string): Promise<DefaultResponse>

- Defined in deluge.ts:575
Parameters
- label: string
Returns Promise<DefaultResponse>

removeTorrent

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

Implementation of TorrentClient.removeTorrent
- Defined in deluge.ts:370
Parameters
- torrentId: string
  
  torrent id from list torrents
- 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 deluge.ts:636
Type Parameters
- T extends object
Parameters
- method: string
- params: any[] = []
- needsAuth: boolean = true
- autoConnect: boolean = true
Returns Promise<Response<T>>

resetSession

resetSession(): void

- Defined in deluge.ts:60
Returns void

resumeTorrent

resumeTorrent(torrentId: string): Promise<DefaultResponse>

Implementation of TorrentClient.resumeTorrent
- Defined in deluge.ts:531
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

setConfig

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

- Defined in deluge.ts:610
Parameters
- config: Partial<DelugeSettings>
Returns Promise<DefaultResponse>

setTorrentLabel

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

- Defined in deluge.ts:565
Parameters
- torrentId: string
- label: string
Returns Promise<DefaultResponse>

setTorrentOptions

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

- Defined in deluge.ts:536
Parameters
- torrentId: string
- options: Partial<TorrentOptions> = {}
Returns Promise<DefaultResponse>

setTorrentTrackers

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

- Defined in deluge.ts:547
Parameters
- torrentId: string
- trackers: Tracker[] = []
Returns Promise<DefaultResponse>

updateTorrentTrackers

updateTorrentTrackers(torrentId: string): Promise<DefaultResponse>

- Defined in deluge.ts:555
Parameters
- torrentId: string
Returns Promise<DefaultResponse>

upload

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

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

verifyTorrent

verifyTorrent(torrentId: string): Promise<DefaultResponse>

- Defined in deluge.ts:560
Parameters
- torrentId: string
Returns Promise<DefaultResponse>