LoadBundleTask class

代表載入 Firestore 套件的工作。這個檔案提供軟體包載入的進度,以及工作完成和錯誤事件。

這個 API 與 Promise<LoadBundleTaskProgress> 相容。

簽名:

export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress> 

實作:PromiseLike<LoadBundleTaskProgress>

方法

方法 修飾符 說明
catch(on denied) 實作 Promise<LoadBundleTaskProgress>.catch 介面。
onProgress(next, error, complete) 註冊函式以監聽套件載入進度事件。
then(onFulfilled, on denied) 實作 Promise<LoadBundleTaskProgress>.then 介面。

LoadBundleTask.catch()

實作 Promise<LoadBundleTaskProgress>.catch 介面。

簽名:

catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;

參數

參數 類型 說明
已遭拒 (a:錯誤) =>R |承諾<R> 在系統載入套件時發生錯誤時呼叫。

傳回:

Promise<R |LoadBundleTaskProgress>

LoadBundleTask.onProgress()

註冊函式以監聽套件載入進度事件。

簽名:

onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;

參數

參數 類型 說明
下一個 (進度:LoadBundleTaskProgress) =>不明 有來自套件載入的進度更新時呼叫。每次從套件載入 Firestore 文件時,通常都會發生 next 呼叫。
錯誤 (err:錯誤) =>不明 在系統載入套件時發生錯誤時呼叫。工作回報後即會取消,之後應該不會再更新。
完成 () =>void 載入工作完成時呼叫。

傳回:

void

LoadBundleTask.then()

實作 Promise<LoadBundleTaskProgress>.then 介面。

簽名:

then<T, R>(onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>, onRejected?: (a: Error) => R | PromiseLike<R>): Promise<T | R>;

參數

參數 類型 說明
onFulfill (a:LoadBundleTaskProgress) =>T |承諾<T> 完成 LoadBundleTaskProgress 更新的載入工作完成後,會呼叫此方法。更新作業的 taskState 將一律設為 "Success"
已遭拒 (a:錯誤) =>R |承諾<R> 在系統載入套件時發生錯誤時呼叫。

傳回:

Promise<T |右