Back to Firebase Js Sdk

LoadBundleTaskProgress interface

docs-devsite/firestore_.loadbundletaskprogress.md

12.12.12.0 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

LoadBundleTaskProgress interface

Represents a progress update or a final state from loading bundles.

<b>Signature:</b>

typescript
export declare interface LoadBundleTaskProgress 

Properties

PropertyTypeDescription
bytesLoadednumberHow many bytes have been loaded.
documentsLoadednumberHow many documents have been loaded.
taskStateTaskStateCurrent task state.
totalBytesnumberHow many bytes are in the bundle being loaded.
totalDocumentsnumberHow many documents are in the bundle being loaded.

LoadBundleTaskProgress.bytesLoaded

How many bytes have been loaded.

<b>Signature:</b>

typescript
bytesLoaded: number;

LoadBundleTaskProgress.documentsLoaded

How many documents have been loaded.

<b>Signature:</b>

typescript
documentsLoaded: number;

LoadBundleTaskProgress.taskState

Current task state.

<b>Signature:</b>

typescript
taskState: TaskState;

LoadBundleTaskProgress.totalBytes

How many bytes are in the bundle being loaded.

<b>Signature:</b>

typescript
totalBytes: number;

LoadBundleTaskProgress.totalDocuments

How many documents are in the bundle being loaded.

<b>Signature:</b>

typescript
totalDocuments: number;