Represents the task of loading a Firestore bundle. It provides progress of bundleloading, as well as task completion and error events.
The API is compatible withPromise<LoadBundleTaskProgress>.
Index
Methods
Methods
catch
- catch<R>(onRejected: (a: Error) =>R |PromiseLike<R>):Promise<R |LoadBundleTaskProgress>
Implements the
Promise<LoadBundleTaskProgress>.catchinterface.Type parameters
R
Parameters
onRejected:(a:Error) =>R |PromiseLike<R>
Called when an error occurs during bundle loading.
ReturnsPromise<R |LoadBundleTaskProgress>
onProgress
- on
Progress(next?: (progress: LoadBundleTaskProgress) =>any, error?: (error: Error) =>any, complete?: () =>void):void Registers functions to listen to bundle loading progress events.
Parameters
Optional next:(progress:LoadBundleTaskProgress) =>any
Called when there is a progress update from bundle loading. Typically
nextcalls occureach time a Firestore document is loaded from the bundle.- (progress:LoadBundleTaskProgress):any
Parameters
progress:LoadBundleTaskProgress
Returnsany
Optional error:(error:Error) =>any
Called when an error occurs during bundle loading. The task aborts after reporting theerror, and there should be no more updates after this.
Optional complete:() =>void
Called when the loading task is complete.
- ():void
Returnsvoid
Returnsvoid
then
- then<T, R>(onFulfilled?: (a: LoadBundleTaskProgress) =>T |PromiseLike<T>, onRejected?: (a: Error) =>R |PromiseLike<R>):Promise<T |R>
Overrides PromiseLike.then
Implements the
Promise<LoadBundleTaskProgress>.theninterface.Type parameters
T
R
Parameters
Optional onFulfilled:(a:LoadBundleTaskProgress) =>T |PromiseLike<T>
Called on the completion of the loading task with a final
LoadBundleTaskProgressupdate.The update will always have itstaskStateset to"Success".- (a:LoadBundleTaskProgress):T |PromiseLike<T>
Parameters
ReturnsT |PromiseLike<T>
Optional onRejected:(a:Error) =>R |PromiseLike<R>
Called when an error occurs during bundle loading.
ReturnsPromise<T |R>
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-27 UTC.