Class Rqbit

constructor

• new Rqbit(options?: Partial<RqbitConfig>): Rqbit

  Parameters

  • options: Partial<RqbitConfig> = {}

  Returns Rqbit

config

state

StaticcreateFromState

• createFromState(
      config: Readonly<Partial<RqbitConfig>>,
      state: Readonly<Jsonify<RqbitState>>,
  ): Rqbit

  Parameters

  • config: Readonly<Partial<RqbitConfig>>
  • state: Readonly<Jsonify<RqbitState>>

  Returns Rqbit

exportState

• exportState(): Jsonify<RqbitState>

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

  Returns Jsonify<RqbitState>

getApiInfo

• getApiInfo(): Promise<ApiRootResponse>

  Lists the available api endpoints and the rqbit version

  Returns Promise<ApiRootResponse>

getVersion

• getVersion(): Promise<string>

  rqbit version, ex - 9.0.1

  Returns Promise<string>

getSessionStats

• getSessionStats(): Promise<SessionStats>

  Session wide download/upload speed, peer and connection stats

  Returns Promise<SessionStats>

getDhtStats

• getDhtStats(): Promise<DhtStats>

  Returns Promise<DhtStats>

getRateLimits

• getRateLimits(): Promise<RateLimits>

  Returns Promise<RateLimits>

setRateLimits

• setRateLimits(limits: RateLimits): Promise<EmptyResponse>

  Set session wide rate limits in bytes per second, null removes the limit

  Parameters

  • limits: RateLimits

  Returns Promise<EmptyResponse>

listTorrents

• listTorrents(withStats: true): Promise<ListTorrentsResponse<TorrentWithStats>>

  Parameters

  • withStats: true

  Returns Promise<ListTorrentsResponse<TorrentWithStats>>

• listTorrents(withStats?: false): Promise<ListTorrentsResponse<TorrentListItem>>

  Parameters

  • OptionalwithStats: false

  Returns Promise<ListTorrentsResponse<TorrentListItem>>

getTorrentDetails

• getTorrentDetails(id: TorrentIdOrHash): Promise<TorrentDetails>

  Torrent details including the file list

  Parameters

  • id: TorrentIdOrHash

  Returns Promise<TorrentDetails>

getTorrentStats

• getTorrentStats(id: TorrentIdOrHash): Promise<TorrentStats>

  Parameters

  • id: TorrentIdOrHash

  Returns Promise<TorrentStats>

getTorrentPeerStats

• getTorrentPeerStats(
      id: TorrentIdOrHash,
      state?: "live" | "all",
  ): Promise<PeerStatsResponse>

  Per peer stats, defaults to only live peers

  Parameters

  • id: TorrentIdOrHash
  • state: "live" | "all" = 'live'

  Returns Promise<PeerStatsResponse>

getTorrentMetadata

• getTorrentMetadata(id: TorrentIdOrHash): Promise<Uint8Array<ArrayBuffer>>

  Download the .torrent file for a torrent

  Parameters

  • id: TorrentIdOrHash

  Returns Promise<Uint8Array<ArrayBuffer>>

getStreamUrl

• getStreamUrl(id: TorrentIdOrHash, fileIndex: number): string

  Url to stream a file from a torrent, supports range requests. rqbit requires basic auth on this url when it is enabled. https://github.com/ikatson/rqbit/blob/v9.0.1/crates/librqbit/src/http_api/handlers/streaming.rs

  Parameters

  • id: TorrentIdOrHash
  • fileIndex: number

    index into the torrent's file list

  Returns string

getPlaylistUrl

• getPlaylistUrl(id?: TorrentIdOrHash): string

  Url to an m3u8 playlist of a torrent's playable files, or every torrent's when no id is passed. rqbit requires basic auth on this url when it is enabled.

  Parameters

  • Optionalid: TorrentIdOrHash

  Returns string

pauseTorrent

• pauseTorrent(id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<void>

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

  Parameters

  • id: TorrentIdOrHash | TorrentIdOrHash[]

  Returns Promise<void>

resumeTorrent

• resumeTorrent(id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<void>

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

  Parameters

  • id: TorrentIdOrHash | TorrentIdOrHash[]

  Returns Promise<void>

removeTorrent

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

  Remove a torrent

  Parameters

  • id: TorrentIdOrHash | TorrentIdOrHash[]
  • removeData: boolean = false

    (default: false) If true, remove the downloaded files.

  Returns Promise<void>

  Throws

  when a torrent doesn't exist

setTorrentFiles

• setTorrentFiles(id: TorrentIdOrHash, fileIds: number[]): Promise<EmptyResponse>

  Change which files are downloaded

  Parameters

  • id: TorrentIdOrHash
  • fileIds: number[]

    indexes into the torrent's file list

  Returns Promise<EmptyResponse>

addPeers

• addPeers(id: TorrentIdOrHash, peers: string[]): Promise<{ added: number }>

  Connect to additional peers

  Parameters

  • id: TorrentIdOrHash
  • peers: string[]

    ex - ['1.2.3.4:6881']

  Returns Promise<{ added: number }>

queueUp

• queueUp(_id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<never>

  rqbit does not support queueing

  Parameters

  • _id: TorrentIdOrHash | TorrentIdOrHash[]

  Returns Promise<never>

queueDown

• queueDown(_id: TorrentIdOrHash | TorrentIdOrHash[]): Promise<never>

  rqbit does not support queueing

  Parameters

  • _id: TorrentIdOrHash | TorrentIdOrHash[]

  Returns Promise<never>

addMagnet

• addMagnet(
      url: string,
      options?: Partial<AddTorrentOptions>,
  ): Promise<AddTorrentResponse>

  Add a magnet link or a url to a .torrent file. rqbit resolves magnet metadata from peers before it responds, so this can take a while, see RqbitConfig.addTimeout https://github.com/ikatson/rqbit/blob/v9.0.1/crates/librqbit/src/http_api/handlers/torrents.rs

  Parameters

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

  Returns Promise<AddTorrentResponse>

addTorrent

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

  Add a torrent

  Parameters

  • torrent: string | Uint8Array<ArrayBuffer>

    .torrent file contents, or the file contents as a base64 string. Magnet links and urls are passed to Rqbit.addMagnet

  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<AddTorrentResponse>

resolveMagnet

• resolveMagnet(
      magnet: string,
      options?: Partial<Pick<AddTorrentOptions, "timeout_ms">>,
  ): Promise<Uint8Array<ArrayBuffer>>

  Resolve a magnet link to .torrent file contents without adding it. Like adding, rqbit fetches the metadata from peers before it responds, see RqbitConfig.addTimeout

  Parameters

  • magnet: string
  • options: Partial<Pick<AddTorrentOptions, "timeout_ms">> = {}

  Returns Promise<Uint8Array<ArrayBuffer>>

createTorrent

• createTorrent(
      folder: string,
      options?: Partial<CreateTorrentOptions>,
  ): Promise<CreateTorrentResponse>

  Create a torrent from a folder on the rqbit server and start seeding it. rqbit must be started with --http-api-allow-create or RQBIT_HTTP_API_ALLOW_CREATE=true.

  Parameters

  • folder: string

    path to the folder on the rqbit server

  • options: Partial<CreateTorrentOptions> = {}

  Returns Promise<CreateTorrentResponse>

normalizedAddTorrent

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

  Add a torrent and return normalized torrent data. The add endpoint has no paused option, startPaused pauses the torrent after adding. rqbit does not support labels, label is ignored. https://github.com/ikatson/rqbit/blob/v9.0.1/crates/librqbit/src/http_api_types.rs

  Parameters

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

  Returns Promise<NormalizedTorrent>

getTorrent

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

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

  Parameters

  • id: TorrentIdOrHash

  Returns Promise<NormalizedTorrent>

getAllData

• getAllData(): Promise<AllClientData>

  rqbit does not support labels so labels is always empty

  Returns Promise<AllClientData>

request

• request<T, R extends ResponseType = "json">(
      path: string,
      options?: FetchOptions<R>,
  ): Promise<MappedResponseType<R, T>>

  Type Parameters

  • T
  • R extends ResponseType = "json"

  Parameters

  • path: string
  • options: FetchOptions<R> = {}

  Returns Promise<MappedResponseType<R, T>>