Firestore バンドルを読み込むタスクを表します。バンドルの読み込みの進行状況、タスクの完了、エラーイベントを提供します。
この API は Promise<LoadBundleTaskProgress>
と互換性があります。
署名:
export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress>
実装: PromiseLike<LoadBundleTaskProgress>
メソッド
メソッド | 修飾キー | 説明 |
---|---|---|
catch(onRejected) | Promise<LoadBundleTaskProgress>.catch インターフェースを実装します。 |
|
onProgress(next, error, complete) | バンドル読み込みの進行状況イベントをリッスンする関数を登録します。 | |
then(onFulfilled、onRejected) | Promise<LoadBundleTaskProgress>.then インターフェースを実装します。 |
LoadBundleTask.catch()
Promise<LoadBundleTaskProgress>.catch
インターフェースを実装します。
署名:
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
onRejected | (a:エラー)=>R |PromiseLike<R> | バンドルの読み込み中にエラーが発生した場合に呼び出されます。 |
戻り値:
Promise<R |LoadBundleTaskProgress>
LoadBundleTask.onProgress()
バンドル読み込みの進行状況イベントをリッスンする関数を登録します。
署名:
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
次 | (進行状況: LoadBundleTaskProgress)=>不明 | バンドルの読み込みから進行状況の更新がある場合に呼び出されます。通常、next 呼び出しは Firestore ドキュメントがバンドルから読み込まれるたびに発生します。 |
エラー | (エラー: エラー)=>不明 | バンドルの読み込み中にエラーが発生した場合に呼び出されます。エラーの報告後にタスクが中止され、その後は更新がなくなります。 |
完了 | () =>無効 | 読み込みタスクが完了したときに呼び出されます。 |
戻り値:
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)=>火 |PromiseLike<T> | 最後の LoadBundleTaskProgress の更新で読み込みタスクが完了したときに呼び出されます。アップデートでは、常に taskState が "Success" に設定されます。 |
onRejected | (a:エラー)=>R |PromiseLike<R> | バンドルの読み込み中にエラーが発生した場合に呼び出されます。 |
戻り値:
Promise<T |R >