brows3r — TypeScript API
    Preparing search index...

    Interface Transfer

    Full state record for one download or upload transfer.

    Mirrors Transfer in src-tauri/src/transfers/mod.rs.

    OCP: checksum, priority, retries may be added here later without breaking existing consumers.

    interface Transfer {
        batchId?: string;
        bucket: string;
        destPath?: string;
        error?: AppError;
        finishedAt?: number;
        id: string;
        key: string;
        kind: TransferKind;
        partsDone: number;
        partsTotal: number;
        profileId: string;
        sourcePath?: string;
        startedAt: number;
        state: TransferState;
        totalBytes?: number;
        transferredBytes: number;
    }
    Index

    Properties

    batchId?: string

    Optional group identifier. Every Transfer kicked off by the same user gesture (one click on Download, one drag-drop, one bulk Upload) shares the same batchId, so the Transfer Manager can render them under a single collapsible parent row instead of as dozens of flat rows.

    Frontend-only — generated client-side and never round-tripped to the backend.

    bucket: string
    destPath?: string

    Destination local path for downloads. Absent for uploads.

    error?: AppError

    AppError details when state is "failed". Hydrated from the transfer:state event payload (or transfer_list snapshot) and used by TransferRow to render the failure reason.

    finishedAt?: number

    Unix timestamp (milliseconds) when the transfer reached a terminal state.

    id: string

    UUID v4 request identifier.

    key: string

    S3 object key.

    partsDone: number

    Multipart parts completed so far.

    partsTotal: number

    Total multipart parts, if applicable.

    profileId: string
    sourcePath?: string

    Source local path for uploads. Absent for downloads.

    startedAt: number

    Unix timestamp (milliseconds) when the transfer was registered.

    totalBytes?: number

    Total bytes, if known before the transfer starts.

    transferredBytes: number

    Bytes transferred so far.