表示加载 Firestore 软件包的任务。它提供了软件包加载的进度,以及任务完成和错误事件。
该 API 与 Promise<LoadBundleTaskProgress>
兼容。
签名:
export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress>
实现:PromiseLike<LoadBundleTaskProgress>
方法
方法 | 修饰符 | 说明 |
---|---|---|
catch(onRejected) | 实现 Promise<LoadBundleTaskProgress>.catch 接口。 |
|
onProgress(next, 错误, complete) | 注册函数,以监听 app bundle 加载进度事件。 | |
then(onFulified, onRejected) | 实现 Promise<LoadBundleTaskProgress>.then 接口。 |
LoadBundleTask.catch()
实现 Promise<LoadBundleTaskProgress>.catch
接口。
签名:
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
参数
参数 | 类型 | 说明 |
---|---|---|
onRejected | (a:错误)=>右 |PromiseLike<R> | 在加载 bundle 期间出错时调用。 |
返回:
承诺<R |LoadBundleTaskProgress>
LoadBundleTask.onProgress()
注册函数,以监听 app bundle 加载进度事件。
签名:
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
参数
参数 | 类型 | 说明 |
---|---|---|
下一个 | (进度:LoadBundleTaskProgress)=>未知 | 在加载 bundle 的过程中有进度更新时调用。通常,每次从 bundle 加载 Firestore 文档时,都会发生 next 调用。 |
error | (错误:错误)=>未知 | 在加载 bundle 期间出错时调用。任务在报告错误后取消,此后应该不再有更新。 |
complete | () =>无效 | 在加载任务完成时调用。 |
返回:
void
LoadBundleTask.then()
实现 Promise<LoadBundleTaskProgress>.then
接口。
签名:
then<T, R>(onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>, onRejected?: (a: Error) => R | PromiseLike<R>): Promise<T | R>;
参数
参数 | 类型 | 说明 |
---|---|---|
已完成 | (a:LoadBundleTaskProgress)=>T |Promise 类似于<T> | 通过最终的 LoadBundleTaskProgress 更新在加载任务完成时调用。更新会始终将其 taskState 设置为 "Success" 。 |
onRejected | (a:错误)=>右 |PromiseLike<R> | 在加载 bundle 期间出错时调用。 |
返回:
承诺<T |R>