表示加载 Firestore 捆绑包的任务。它提供包加载的进度,以及任务完成和错误事件。
该 API 与Promise<LoadBundleTaskProgress>
兼容。
签名:
export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress>
实现: PromiseLike< LoadBundleTaskProgress >
方法
方法 | 修饰符 | 描述 |
---|---|---|
捕获(拒绝) | 实现Promise<LoadBundleTaskProgress>.catch 接口。 | |
onProgress(下一步、错误、完成) | 注册函数来侦听包加载进度事件。 | |
然后(onFulfilled,onRejected) | 实现Promise<LoadBundleTaskProgress>.then 接口。 |
LoadBundleTask.catch()
实现Promise<LoadBundleTaskProgress>.catch
接口。
签名:
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
参数
范围 | 类型 | 描述 |
---|---|---|
被拒绝时 | (a:错误)=> R | PromiseLike<R> | 当包加载期间发生错误时调用。 |
返回:
承诺<R |加载Bundle任务进度>
LoadBundleTask.onProgress()
注册函数来侦听包加载进度事件。
签名:
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
参数
范围 | 类型 | 描述 |
---|---|---|
下一个 | (进度: LoadBundleTaskProgress ) => 未知 | 当包加载有进度更新时调用。通常,每次从捆绑包加载 Firestore 文档时都会发生next 调用。 |
错误 | (err: 错误) => 未知 | 当包加载期间发生错误时调用。任务在报告错误后中止,此后不应再有更新。 |
完全的 | () => 无效 | 加载任务完成时调用。 |
返回:
空白
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 | PromiseLike<T> | 在加载任务完成并进行最终LoadBundleTaskProgress 更新时调用。更新将始终将其taskState 设置为"Success" 。 |
被拒绝时 | (a:错误)=> R | PromiseLike<R> | 当包加载期间发生错误时调用。 |
返回:
承诺<T | R>