Class TransferFile

Index

Constructors

Methods

clear download getBlob getFile getInfos getMetadata hasPart isComplete isDownloading readFilePart receiveFilePart setBlob setComplete setDownloading setError waitFilePart waitFilePartWithRetry

Constructors

constructor

new TransferFile(
    id: string,
    name: string,
    type: string,
    size: number,
    bufferLength: number,
    timeout?: number,
    retries?: number,
): TransferFile
Generate a new TransferFile instance.
Parameters
- id: string
  Id of the file.
- name: string
  Name of the file.
- type: string
  Type of the file.
- size: number
  Size of the file.
- bufferLength: number
  Length of the internal buffer.
- Optionaltimeout: number
  Timeout for a single check in seconds.
- Optionalretries: number
  Number of retries before considering it as a failure.
Returns TransferFile
- Defined in TransferFile.ts:66

Methods

clear

clear(): void
Clear the content of the file. The user will need to download it again.

Returns void
- Defined in TransferFile.ts:439

download

download(
    maxBufferSize: number,
    askFilePartCallback: AskFilePartCallback,
    parallelCalls?: number,
    timeout?: number,
    retries?: number,
): Promise<void>
Download the file.
Parameters
- maxBufferSize: number
  Maximum length for the data to ask at one time.
- askFilePartCallback: AskFilePartCallback
  Function that will be called to ask for some parts of the file.
- parallelCalls: number = 1
  Number of parallel calls to perform (default value: 1).
- Optionaltimeout: number
  Timeout for a single check in seconds.
- Optionalretries: number
  Number of retries before considering it as a failure.
Returns Promise<void>
- Defined in TransferFile.ts:204

getBlob

getBlob(): Blob
Get the Blob of the complete file.

Returns Blob
The Blob of the file.
- Defined in TransferFile.ts:161

getFile

getFile(): TransferFileBlob
Get informations representing the file.

Returns TransferFileBlob
All informations representing the file.
- Defined in TransferFile.ts:287

getInfos

getInfos(): TransferFileInfos
Get informations about the TransferFile.

Returns TransferFileInfos
Informations about the TransferFile.
- Defined in TransferFile.ts:141

getMetadata

getMetadata(): TransferFileMetadata
Get the file metadata.

Returns TransferFileMetadata
File metadata.
- Defined in TransferFile.ts:272

hasPart

hasPart(offset: number, limit: number): ArrayBuffer
Check the presence of a specific part of the file.
Parameters
- offset: number
  Offset from the start.
- limit: number
  The requested limit.
Returns ArrayBuffer
true if the part exists or if the file is complete.
- Defined in TransferFile.ts:350

isComplete

isComplete(): boolean
Check if the file is complete.

Returns boolean
true if the file is complete.
- Defined in TransferFile.ts:121

isDownloading

isDownloading(): boolean
Check if the file is downloading.

Returns boolean
true if the file is downloading.
- Defined in TransferFile.ts:103

readFilePart

readFilePart(offset: number, limit: number): ArrayBuffer
Read limit bytes at maximum from offset from the file.
Parameters
- offset: number
  Offset from the start.
- limit: number
  Maximum number of bytes to return.
Returns ArrayBuffer
ArrayBuffer with the requested file part.
- Defined in TransferFile.ts:320

receiveFilePart

receiveFilePart(offset: number, limit: number, data: ArrayBuffer): void
Receive a part of the file.
Parameters
- offset: number
  Offset from the start.
- limit: number
  The requested limit.
- data: ArrayBuffer
  ArrayBuffer containing the requested data.
Returns void
- Defined in TransferFile.ts:335

setBlob

setBlob(blob: Blob): Promise<void>
Set a Blob as being the content of this file.
Parameters
- blob: Blob
Returns Promise<void>
- Defined in TransferFile.ts:303

setComplete

setComplete(isComplete?: boolean): void
Set the file as being complete.
Parameters
- isComplete: boolean = true
  True if the download is complete.
Returns void
- Defined in TransferFile.ts:112

setDownloading

setDownloading(isDownloading?: boolean): void
Set the file as being downloaded.
Parameters
- isDownloading: boolean = true
  True if the file is being downloaded.
Returns void
- Defined in TransferFile.ts:94

setError

setError(message: undefined | string, isErrored?: boolean): void
Set an error message.
Parameters
- message: undefined | string
  A relevant error message.
- isErrored: boolean = true
  True in case of an error.
Returns void
- Defined in TransferFile.ts:131

waitFilePart

waitFilePart(offset: number, limit: number, timeout?: number): Promise<boolean>
Wait and check for presence of a specific part of the file.
Parameters
- offset: number
  Offset from the start.
- limit: number
  The requested limit.
- timeout: number = 1
  Timeout in seconds (default: 1)
Returns Promise<boolean>
true of the part was received.
- Defined in TransferFile.ts:362

waitFilePartWithRetry

waitFilePartWithRetry(
    askFilePartCallback: AskFilePartCallback,
    offset: number,
    limit: number,
    timeout?: number,
    retries?: number,
): Promise<void>
Wait for a specific part of a file, with some retries.
Parameters
- askFilePartCallback: AskFilePartCallback
  Function to ask a file part to the sender.
- offset: number
  Offset from the start.
- limit: number
  Maximum number of bytes that we can read.
- Optionaltimeout: number
  Timeout for a single check in seconds.
- Optionalretries: number
  Number of retries before considering it as a failure.
Returns Promise<void>
- Defined in TransferFile.ts:390

Class TransferFile

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TransferFile

Methods

clear

Returns void

download

Parameters

Returns Promise<void>

getBlob

Returns Blob

getFile

Returns TransferFileBlob

getInfos

Returns TransferFileInfos

getMetadata

Returns TransferFileMetadata

hasPart

Parameters

Returns ArrayBuffer

isComplete

Returns boolean

isDownloading

Returns boolean

readFilePart

Parameters

Returns ArrayBuffer

receiveFilePart

Parameters

Returns void

setBlob

Parameters

Returns Promise<void>

setComplete

Parameters

Returns void

setDownloading

Parameters

Returns void

setError

Parameters

Returns void

waitFilePart

Parameters

Returns Promise<boolean>

waitFilePartWithRetry

Parameters

Returns Promise<void>

Settings

On This Page