Firestore バンドルをロードするタスクを表します。バンドルの読み込みの進行状況、タスクの完了およびエラー イベントが表示されます。
API はPromise<LoadBundleTaskProgress>
と互換性があります。 。
サイン:
export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress>
実装: PromiseLike< LoadBundleTaskProgress >
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
catch(拒否された場合) | Promise<LoadBundleTaskProgress>.catch インターフェイスを実装します。 | |
onProgress(次、エラー、完了) | バンドル読み込み進行状況イベントをリッスンする関数を登録します。 | |
then(onFulfilled、onRejected) | Promise<LoadBundleTaskProgress>.then インターフェイスを実装します。 |
LoadBundleTask.catch()
Promise<LoadBundleTaskProgress>.catch
インターフェイスを実装します。
サイン:
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
拒否された場合 | (a: エラー) => R |プロミスライク<R> | バンドルのロード中にエラーが発生したときに呼び出されます。 |
戻り値:
約束<R |ロードバンドルタスクの進行状況>
LoadBundleTask.onProgress()
バンドル読み込み進行状況イベントをリッスンする関数を登録します。
サイン:
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
次 | (進行状況: LoadBundleTaskProgress ) => 不明 | バンドルの読み込みによる進行状況の更新があるときに呼び出されます。通常、 next 呼び出しは、Firestore ドキュメントがバンドルからロードされるたびに発生します。 |
エラー | (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 |プロミスライク<T> | 最終的なLoadBundleTaskProgress 更新による読み込みタスクの完了時に呼び出されます。更新では、常にtaskState "Success" に設定されます。 |
拒否された場合 | (a: エラー) => R |プロミスライク<R> | バンドルのロード中にエラーが発生したときに呼び出されます。 |
戻り値:
約束<T | R>