UploadTaskSnapshot interface

Holds data about the current state of the upload task.

Signature:

export interface UploadTaskSnapshot

Properties

Property Type Description
bytesTransferred number The number of bytes that have been successfully uploaded so far.
metadata FullMetadata Before the upload completes, contains the metadata sent to the server. After the upload completes, contains the metadata sent back from the server.
ref StorageReference The reference that spawned this snapshot's upload task.
state TaskState The current state of the task.
task UploadTask The task of which this is a snapshot.
totalBytes number The total number of bytes to be uploaded.

UploadTaskSnapshot.bytesTransferred

The number of bytes that have been successfully uploaded so far.

Signature:

bytesTransferred: number;

UploadTaskSnapshot.metadata

Before the upload completes, contains the metadata sent to the server. After the upload completes, contains the metadata sent back from the server.

Signature:

metadata: FullMetadata;

UploadTaskSnapshot.ref

The reference that spawned this snapshot's upload task.

Signature:

ref: StorageReference;

UploadTaskSnapshot.state

The current state of the task.

Signature:

state: TaskState;

UploadTaskSnapshot.task

The task of which this is a snapshot.

Signature:

task: UploadTask;

UploadTaskSnapshot.totalBytes

The total number of bytes to be uploaded.

Signature:

totalBytes: number;