RTCForge API Reference v1.1.1
    Preparing search index...

    Interface TransferProgress

    Immutable snapshot of a transfer's progress, emitted with TransferEvent.Progress.

    interface TransferProgress {
        ratio: number;
        totalBytes: number;
        totalChunks: number;
        transferId: string;
        transferredBytes: number;
        transferredChunks: number;
    }
    Index

    Properties

    ratio: number

    Fraction complete in the range [0, 1].

    totalBytes: number

    Total bytes to transfer (the file size).

    totalChunks: number

    Total number of chunks the file is split into.

    transferId: string

    Identifier of the transfer this snapshot describes.

    transferredBytes: number

    Bytes transferred so far.

    transferredChunks: number

    Number of chunks transferred so far.