Class FileTransfer

Hierarchy

FileTransfer

Index

Constructors

Properties

torrentOpts torrents webTorrentClient

Methods

destroy download getDecryptedFileReadStream isOffering offer rescind rescindAll saveTorrentFiles

Constructors

constructor

new FileTransfer(options?: FileTransferOpts): FileTransfer
Parameters
- options: FileTransferOpts = {}
Returns FileTransfer
- Defined in index.ts:125

Properties

`Private` torrentOpts

torrentOpts: TorrentOptions

`Private` torrents

torrents: Record<string, Torrent> = {}

`Private` webTorrentClient

webTorrentClient: Instance

Methods

destroy

destroy(): void
General-purpose cleanup method for when this FileTransfer instance is no longer needed.

Returns void
- Defined in index.ts:136

download

download(magnetURI: string, password: string, downloadOpts?: DownloadOpts): Promise<TorrentFile[]>
Downloads and decrypts the files associated with magnetURI. For the download operation to succeed, the peer offering the file must maintain their offer until the downloading peer has finished downloading the data.

Returns
An array of downloaded files.
Parameters
- magnetURI: string
  
  A string that was returned by offer.
- password: string
  
  The password to decrypt the files with. Must be the same as the password parameter that was provided to the offer call that produced magnetURI.
- downloadOpts: DownloadOpts = {}
Returns Promise<TorrentFile[]>
- Defined in index.ts:153

`Private` getDecryptedFileReadStream

getDecryptedFileReadStream(file: TorrentFile, password: string): Promise<ReadableStream<any>>
Parameters
- file: TorrentFile
- password: string
Returns Promise<ReadableStream<any>>
- Defined in index.ts:95

isOffering

isOffering(magnetURI: string): boolean
Whether or not an offer associated with magnetURI is currently being made.
Parameters
- magnetURI: string
Returns boolean
- Defined in index.ts:354

offer

offer(files: FileList | File[], password: string, offerOpts?: OfferOpts): Promise<string>
Makes a list of files available to others to download.

Returns
The torrent magnet URI that peers can use to download the offered file with download.
Parameters
- files: FileList | File[]
  
  The Files to offer to a peer.
- password: string
  
  The encryption key for the files.
- offerOpts: OfferOpts = {}
Returns Promise<string>
- Defined in index.ts:243

rescind

rescind(magnetURI: string): void
Rescinds a file offer that was made by offer.
Parameters
- magnetURI: string
Returns void
- Defined in index.ts:329

rescindAll

rescindAll(): void
Rescinds all file offers.

Returns void
- Defined in index.ts:344

`Private` saveTorrentFiles

saveTorrentFiles(files: TorrentFile[]): Promise<void>
Parameters
- files: TorrentFile[]
Returns Promise<void>
- Defined in index.ts:108

Generated using TypeDoc