Class Deluge

constructor

• new Deluge(options?: Partial<TorrentClientConfig>): Deluge

  Parameters

  • options: Partial<TorrentClientConfig> = {}

  Returns Deluge

config

state

addLabel

• addLabel(label: string): Promise<DefaultResponse>

  Parameters

  • label: string

  Returns Promise<DefaultResponse>

addTorrent

• addTorrent(
      torrent: string | Uint8Array<ArrayBuffer>,
      options?: Partial<AddTorrentOptions>,
  ): Promise<AddTorrentResponse>

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>
  • options: Partial<AddTorrentOptions> = {}

    anything left out uses the daemon's core.conf defaults

  Returns Promise<AddTorrentResponse>

addTorrentMagnet

• addTorrentMagnet(
      magnet: string,
      options?: Partial<AddTorrentOptions>,
  ): Promise<StringStatus>

  Parameters

  • magnet: string
  • options: Partial<AddTorrentOptions> = {}

    anything left out uses the daemon's core.conf defaults

  Returns Promise<StringStatus>

  the torrent id

changePassword

• changePassword(password: string): Promise<BooleanStatus>

  Parameters

  • password: string

  Returns Promise<BooleanStatus>

checkSession

• checkSession(): Promise<boolean>

  Checks current session is valid

  Returns Promise<boolean>

  true if valid

connect

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

  Connects deluge and returns a list of available methods

  Parameters

  • OptionalselectedHost: string
  • hostIdx: number = 0

    index of host to use in result of get hosts

  Returns Promise<ListMethods>

connected

• connected(): Promise<boolean>

  Returns Promise<boolean>

disablePlugin

• disablePlugin(plugin: string | string[]): Promise<BooleanStatus>

  Parameters

  • plugin: string | string[]

    plugin name, an array is still accepted but deluge only reads one name

  Returns Promise<BooleanStatus>

disconnect

• disconnect(): Promise<boolean>

  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>

  Download a torrent from url, pass the result to Deluge.addTorrent

  Parameters

  • url: string
  • cookies: string = ''

  Returns Promise<string>

  file path

enablePlugin

• enablePlugin(plugin: string | string[]): Promise<BooleanStatus>

  Parameters

  • plugin: string | string[]

    plugin name, an array is still accepted but deluge only reads one name

  Returns Promise<BooleanStatus>

exportState

• exportState(): Jsonify<DelugeState>

  Export the current state of the client. Can be restored with createFromState.

  Returns Jsonify<DelugeState>

getAllData

• getAllData(): Promise<AllClientData>

  Returns all torrent data. Data has been normalized

  Returns Promise<AllClientData>

getConfig

• getConfig(): Promise<ConfigResponse>

  Returns Promise<ConfigResponse>

getFreeSpace

• getFreeSpace(path?: string): Promise<NumberStatus>

  Free bytes at path, -1 when the path doesn't exist https://github.com/deluge-torrent/deluge/blob/deluge-2.2.0/deluge/core/core.py#L1244

  Parameters

  • Optionalpath: string

    defaults to the download location

  Returns Promise<NumberStatus>

getHosts

• getHosts(): Promise<GetHostsResponse>

  Returns Promise<GetHostsResponse>

getHostStatus

• getHostStatus(host: string): Promise<GetHostStatusResponse>

  Gets host status

  Parameters

  • host: string

    pass host id from this.getHosts()

  Returns Promise<GetHostStatusResponse>

getLabels

• getLabels(): Promise<ListMethods>

  Returns Promise<ListMethods>

getMagnetInfo

• getMagnetInfo(uri: string): Promise<MagnetInfoResponse>

  Parses a magnet uri for its hash, name and trackers

  Parameters

  • uri: string

  Returns Promise<MagnetInfoResponse>

getMagnetUri

• getMagnetUri(torrentId: string): Promise<StringStatus>

  Parameters

  • torrentId: string

  Returns Promise<StringStatus>

getPluginInfo

• getPluginInfo(plugin: string | string[]): Promise<PluginInfo>

  Parameters

  • plugin: string | string[]

    plugin name, an array is still accepted but deluge only reads one name

  Returns Promise<PluginInfo>

getPlugins

• getPlugins(): Promise<PluginsListResponse>

  Returns Promise<PluginsListResponse>

getTorrent

• getTorrent(id: string): Promise<NormalizedTorrent>

  Throws a TorrentClientError with the torrent_not_found code when the torrent doesn't exist

  Parameters

  • id: string

  Returns Promise<NormalizedTorrent>

getTorrentFiles

• getTorrentFiles(torrentId: string): Promise<TorrentFiles>

  Get list of files for a torrent

  Parameters

  • torrentId: string

  Returns Promise<TorrentFiles>

getTorrentInfo

• getTorrentInfo(tmpPath: string): Promise<TorrentInfo>

  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>

  get torrent state/status

  Parameters

  • torrentId: string
  • additionalFields: string[] = []

    fields ex - ['label']

  Returns Promise<TorrentStatus>

getVersion

• getVersion(): Promise<StringStatus>

  returns the version ex - 2.0.3-2-201906121747-ubuntu18.04.1

  Returns Promise<StringStatus>

isSessionPaused

• isSessionPaused(): Promise<BooleanStatus>

  Returns Promise<BooleanStatus>

listMethods

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

  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>

  Parameters

  • additionalFields: string[] = []
  • filter: Record<string, string> = {}

  Returns Promise<TorrentListResponse>

login

• login(): Promise<boolean>

  Login deluge

  Returns Promise<boolean>

  true if success

logout

• logout(): Promise<boolean>

  Logout deluge

  Returns Promise<boolean>

  true if success

moveStorage

• moveStorage(torrentIds: string[], destination: string): Promise<DefaultResponse>

  Moves the torrent data, returns before the move finishes

  Parameters

  • torrentIds: string[]
  • destination: string

  Returns Promise<DefaultResponse>

normalizedAddTorrent

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

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>
  • options: Partial<NormalizedAddTorrentOptions> = {}

  Returns Promise<NormalizedTorrent>

pauseSession

• pauseSession(): Promise<DefaultResponse>

  Pauses every torrent

  Returns Promise<DefaultResponse>

pauseTorrent

• pauseTorrent(torrentId: string | string[]): Promise<void>

  Pause one or more torrents, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist

  Parameters

  • torrentId: string | string[]

  Returns Promise<void>

queueBottom

• queueBottom(torrentId: string): Promise<DefaultResponse>

  Parameters

  • torrentId: string

  Returns Promise<DefaultResponse>

queueDown

• queueDown(torrentId: string | string[]): Promise<void>

  Move one or more torrents down the queue, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist, throws when the client has no queue

  Parameters

  • torrentId: string | string[]

  Returns Promise<void>

queueTop

• queueTop(torrentId: string): Promise<DefaultResponse>

  Parameters

  • torrentId: string

  Returns Promise<DefaultResponse>

queueUp

• queueUp(torrentId: string | string[]): Promise<void>

  Move one or more torrents up the queue, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist, throws when the client has no queue

  Parameters

  • torrentId: string | string[]

  Returns Promise<void>

removeLabel

• removeLabel(label: string): Promise<DefaultResponse>

  Parameters

  • label: string

  Returns Promise<DefaultResponse>

removeTorrent

• removeTorrent(torrentId: string | string[], removeData?: boolean): Promise<void>

  Parameters

  • torrentId: string | string[]

    one or more torrent ids from list torrents

  • removeData: boolean = false

    (default: false) If true, remove the data from disk

  Returns Promise<void>

  Throws

  when a torrent doesn't exist

removeTorrents

• removeTorrents(
      torrentIds: string[],
      removeData?: boolean,
  ): Promise<RemoveTorrentsResponse>

  Parameters

  • torrentIds: string[]
  • removeData: boolean = false

    (default: false) If true, remove the data from disk

  Returns Promise<RemoveTorrentsResponse>

renameFiles

• renameFiles(
      torrentId: string,
      files: [number, string][],
  ): Promise<DefaultResponse>

  Renames files in a torrent, libtorrent renames them async so the new names can take a moment to show up

  Parameters

  • torrentId: string
  • files: [number, string][]

    [fileIndex, newPath] pairs, the path can include folders

  Returns Promise<DefaultResponse>

renameFolder

• renameFolder(
      torrentId: string,
      folder: string,
      newFolder: string,
  ): Promise<DefaultResponse>

  Renames a folder by renaming every file under it

  Parameters

  • torrentId: string
  • folder: string

    ex - 'folder/'

  • newFolder: string

    an empty string moves the contents up to the parent folder

  Returns Promise<DefaultResponse>

request

• request<T extends object>(
      method: string,
      params?: any[],
      needsAuth?: boolean,
      autoConnect?: boolean,
  ): Promise<Promise<FetchResponse<T>>>

  Type Parameters

  • T extends object

  Parameters

  • method: string
  • params: any[] = []
  • needsAuth: boolean = true
  • autoConnect: boolean = true

  Returns Promise<Promise<FetchResponse<T>>>

resetSession

• resetSession(): void

  Returns void

resumeSession

• resumeSession(): Promise<DefaultResponse>

  Returns Promise<DefaultResponse>

resumeTorrent

• resumeTorrent(torrentId: string | string[]): Promise<void>

  Resume one or more torrents, clients resolve with void. Throws torrent_not_found when a torrent doesn't exist

  Parameters

  • torrentId: string | string[]

  Returns Promise<void>

setConfig

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

  Parameters

  • config: Partial<DelugeSettings>

  Returns Promise<DefaultResponse>

setTorrentLabel

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

  Parameters

  • torrentId: string
  • label: string

  Returns Promise<DefaultResponse>

setTorrentOptions

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

  Parameters

  • torrentId: string
  • options: Partial<TorrentOptions> = {}

  Returns Promise<DefaultResponse>

setTorrentTrackers

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

  Parameters

  • torrentId: string
  • trackers: Tracker[] = []

  Returns Promise<DefaultResponse>

updateTorrentTrackers

• updateTorrentTrackers(torrentId: string): Promise<DefaultResponse>

  Parameters

  • torrentId: string

  Returns Promise<DefaultResponse>

upload

• upload(torrent: string | Uint8Array<ArrayBuffer>): Promise<UploadResponse>

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>

  Returns Promise<UploadResponse>

verifyTorrent

• verifyTorrent(torrentId: string): Promise<DefaultResponse>

  Parameters

  • torrentId: string

  Returns Promise<DefaultResponse>

StaticcreateFromState

• createFromState(
      config: Readonly<TorrentClientConfig>,
      state: Readonly<Jsonify<DelugeState>>,
  ): Deluge

  Parameters

  • config: Readonly<TorrentClientConfig>
  • state: Readonly<Jsonify<DelugeState>>

  Returns Deluge