Type Alias TransferEvents

Event map for Transfer (and its SendTransfer / ReceiveTransfer subclasses), mapping each TransferEvent to its listener argument tuple.

type TransferEvents = {
    complete: [transferId: string];
    error: [error: FileTransferError];
    progress: [progress: TransferProgress];
    "state-changed": [state: TransferState, previous: TransferState];
}

Index

Properties

complete error progress state-changed

Properties

complete

complete: [transferId: string]

Successful completion, carrying the transfer id.

error

error: [error: FileTransferError]

Failure or reasoned cancellation, carrying the FileTransferError.

progress

progress: [progress: TransferProgress]

Progress update carrying the latest TransferProgress snapshot.

state-changed

"state-changed": [state: TransferState, previous: TransferState]

State transition: the new state followed by the previous one.