LoadBundleTask class

表示載入 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>