@ctrl/qbittorrent
    Preparing search index...

    Class QBittorrent

    Hierarchy

    • QBittorrentSession
      • QBittorrent

    Implements

    • TorrentClient
    Index

    Constructors

    constructor

    Properties

    config state

    Methods

    addMagnet addTorrent addTorrentTags addTrackers bottomPriority createCategory createTags deleteApiKey deleteTags editCategory editTrackers exportState fetchTorrentMetadata getAllData getApiVersion getAppVersion getBuildInfo getCategories getCookies getDefaultSavePath getDirectoryContent getPreferences getProcessInfo getSyncMainData getTags getTorrent getTorrentDownloadLimit getTorrentUploadLimit listTorrents loadClientData login logout normalizedAddTorrent parseTorrentMetadata pauseTorrent queueDown queueUp reannounceTorrent recheckTorrent removeCategory removeTorrent removeTorrentTags removeTrackers renameFile renameFolder request requestArrayBuffer resetTorrentCategory resumeTorrent rotateApiKey saveTorrentMetadata setCookies setFilePriority setPreferences setTorrentCategory setTorrentComment setTorrentDownloadLimit setTorrentLocation setTorrentName setTorrentUploadLimit startTorrent stopTorrent storeClientData topPriority torrentFiles torrentPeers torrentPieceAvailability torrentPieceHashes torrentPieceStates torrentProperties torrentTrackers torrentWebSeeds version createFromState

    Constructors

    Properties

    config: QBittorrentConfig
    state: QBittorrentState = {}

    Methods

    • Parameters

      Returns Promise<boolean>

    • Export the state of the client as JSON

      Returns Jsonify<QBittorrentState>

    • Returns all torrent data. Data has been normalized

      Returns Promise<AllClientData>

    • Get default save path

      Returns Promise<string>

    • Parameters

      • hash: string

      Returns Promise<NormalizedTorrent>

    • Torrents list

      Parameters

      • hashes: {
            category?: string;
            filter?: TorrentFilters;
            hashes?: string | string[];
            includeFiles?: boolean;
            includeTrackers?: boolean;
            isPrivate?: boolean;
            limit?: number;
            offset?: number;
            reverse?: boolean;
            sort?: string;
            tag?: string;
        } = {}

        Filter by torrent hashes

        • Optionalcategory?: string
        • Optionalfilter?: TorrentFilters
        • Optionalhashes?: string | string[]
        • OptionalincludeFiles?: boolean

          Include torrent files in each returned torrent. Added in qBittorrent WebUI API v2.11.8. https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2118

        • OptionalincludeTrackers?: boolean
        • OptionalisPrivate?: boolean

          Maps to private query parameter. Renamed to avoid conflict with private keyword.

        • Optionallimit?: number
        • Optionaloffset?: number
        • Optionalreverse?: boolean
        • Optionalsort?: string
        • Optionaltag?: string

      Returns Promise<Torrent[]>

      list of torrents

    • Parameters

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

      Returns Promise<NormalizedTorrent>

    • Parameters

      • hashes: string | string[]

      Returns Promise<boolean>

      Alias for stopTorrent.

    • Parameters

      • hash: string

        Hash for desired torrent

      • oldPath: string

        id of the file to be renamed

      • newPath: string

        new name to be assigned to the file

      Returns Promise<boolean>

    • Type Parameters

      • T

      Parameters

      • path: string
      • method: "POST" | "GET"
      • Optionalparams: Record<string, string | number>
      • Optionalbody: FormData | URLSearchParams
      • headers: Record<string, string> = {}
      • isJson: boolean = true

      Returns Promise<T>

    • Parameters

      • path: string
      • Optionalparams: Record<string, string | number>

      Returns Promise<ArrayBuffer>

    • helper function to remove torrent category

      Parameters

      • hashes: string | string[]

      Returns Promise<boolean>

    • Parameters

      • hashes: string | string[]

      Returns Promise<boolean>

      Alias for startTorrent.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addMagnetaddTorrentaddTorrentTagsaddTrackersbottomPrioritycreateCategorycreateTagsdeleteApiKeydeleteTagseditCategoryeditTrackersexportStatefetchTorrentMetadatagetAllDatagetApiVersiongetAppVersiongetBuildInfogetCategoriesgetCookiesgetDefaultSavePathgetDirectoryContentgetPreferencesgetProcessInfogetSyncMainDatagetTagsgetTorrentgetTorrentDownloadLimitgetTorrentUploadLimitlistTorrentsloadClientDataloginlogoutnormalizedAddTorrentparseTorrentMetadatapauseTorrentqueueDownqueueUpreannounceTorrentrecheckTorrentremoveCategoryremoveTorrentremoveTorrentTagsremoveTrackersrenameFilerenameFolderrequestrequestArrayBufferresetTorrentCategoryresumeTorrentrotateApiKeysaveTorrentMetadatasetCookiessetFilePrioritysetPreferencessetTorrentCategorysetTorrentCommentsetTorrentDownloadLimitsetTorrentLocationsetTorrentNamesetTorrentUploadLimitstartTorrentstopTorrentstoreClientDatatopPrioritytorrentFilestorrentPeerstorrentPieceAvailabilitytorrentPieceHashestorrentPieceStatestorrentPropertiestorrentTrackerstorrentWebSeedsversioncreateFromState