LoadBundleTask class

מייצג את המשימה של טעינת חבילת Firestore. הוא מספק התקדמות של טעינת החבילות, כמו גם השלמת משימה ואירועי שגיאה.

ה-API תואם ל- Promise<LoadBundleTaskProgress> .

חֲתִימָה:

export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress> 

מיישם: PromiseLike< LoadBundleTaskProgress >

שיטות

שיטה משנה תיאור
לתפוס (בנדחה) מיישמת את ממשק 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>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
על נדחה (א: שגיאה) => R | PromiseLike<R> נקרא כאשר מתרחשת שגיאה במהלך טעינת החבילה.

החזרות:

הבטחה<R | LoadBundleTaskProgress >

LoadBundleTask.onProgress()

רושם פונקציות כדי להאזין לאירועי התקדמות טעינת החבילות.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
הַבָּא (התקדמות: LoadBundleTaskProgress ) => לא ידוע נקרא כאשר יש עדכון התקדמות מטעינת החבילה. בדרך כלל הקריאות next מתרחשות בכל פעם שמסמך Firestore נטען מהחבילה.
שְׁגִיאָה (שגיאה: שגיאה) => לא ידוע נקרא כאשר מתרחשת שגיאה במהלך טעינת החבילה. המשימה מופסקת לאחר דיווח על השגיאה, ולא אמורים להיות עדכונים נוספים לאחר מכן.
לְהַשְׁלִים () => בטל נקרא כאשר משימת הטעינה הושלמה.

החזרות:

בָּטֵל

LoadBundleTask.then()

מיישמת את ממשק Promise<LoadBundleTaskProgress>.then .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
על מילא (א: LoadBundleTaskProgress ) => T | PromiseLike<T> נקרא על השלמת משימת הטעינה עם עדכון אחרון LoadBundleTaskProgress . העדכון תמיד יגדיר את taskState שלו ל- "Success" .
על נדחה (א: שגיאה) => R | PromiseLike<R> נקרא כאשר מתרחשת שגיאה במהלך טעינת החבילה.

החזרות:

הבטחה<T | R>