Class FileDownload

The FileDownload class is a helper to download and decrypt files from the server.

Index

Constructors

Methods

getFileMetadata getTotalChunks prepare start

Constructors

constructor

new FileDownload(api: FilesAPI, id: string, seed: string): FileDownload
Create a managed FileDownload object.
Parameters
- api: FilesAPI
  The FilesAPI instance to use
- id: string
  The ID of the file to download
- seed: string
  The seed to use for decryption
Returns FileDownload
- Defined in lib/FileDownload.ts:22

Methods

getFileMetadata

getFileMetadata(): FileGetResponse
Get the metadata of the file.

Returns FileGetResponse
The metadata of the file
- Defined in lib/FileDownload.ts:37

getTotalChunks

getTotalChunks(): number
Get the total amount of chunks in the file.

Returns number
The total amount of chunks
- Defined in lib/FileDownload.ts:46

prepare

prepare(): Promise<void>
Prepare the download process.

Returns Promise<void>
A promise that resolves when the download is prepared
- Defined in lib/FileDownload.ts:55

start

start(setBytes: SetBytesFn): Promise<void>
Start the download process.
Parameters
- setBytes: SetBytesFn
  The function to get bytes from the file
Returns Promise<void>
A promise that resolves when the download is complete
- Defined in lib/FileDownload.ts:64