LoadBundleTask class

Reprezentuje zadanie ładowania pakietu Firestore. Zapewnia postęp ładowania pakietu, a także zakończenie zadania i zdarzenia błędów.

Interfejs API jest kompatybilny z Promise<LoadBundleTaskProgress> .

Podpis:

export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress> 

Implementuje: PromiseLike< LoadBundleTaskProgress >

Metody

metoda Modyfikatory Opis
catch(onRejected) Implementuje interfejs Promise<LoadBundleTaskProgress>.catch .
onProgress(następny, błąd, ukończony) Rejestruje funkcje nasłuchujące zdarzeń postępu ładowania pakietu.
następnie(onSpełniony, onOdrzucony) Implementuje interfejs Promise<LoadBundleTaskProgress>.then .

LoadBundleTask.catch()

Implementuje interfejs Promise<LoadBundleTaskProgress>.catch .

Podpis:

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

Parametry

Parametr Typ Opis
onOdrzucony (a: Błąd) => R | ObiecajLike<R> Wywoływana, gdy podczas ładowania pakietu wystąpi błąd.

Zwroty:

Obietnica<R | Postęp ładowania pakietu zadań >

LoadBundleTask.onProgress()

Rejestruje funkcje nasłuchujące zdarzeń postępu ładowania pakietu.

Podpis:

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

Parametry

Parametr Typ Opis
Następny (postęp: LoadBundleTaskProgress ) => nieznane Wywoływana, gdy jest aktualizacja postępu ładowania pakietu. Zazwyczaj next wywołania mają miejsce za każdym razem, gdy dokument Firestore jest ładowany z pakietu.
błąd (err: Błąd) => nieznany Wywoływana, gdy podczas ładowania pakietu wystąpi błąd. Zadanie zostaje przerwane po zgłoszeniu błędu i po tym nie powinno być już żadnych aktualizacji.
kompletny () => pustka Wywoływana po zakończeniu zadania ładowania.

Zwroty:

próżnia

LoadBundleTask.then()

Implementuje interfejs Promise<LoadBundleTaskProgress>.then .

Podpis:

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

Parametry

Parametr Typ Opis
onSpełniony (a: LoadBundleTaskProgress ) => T | ObiecajLike<T> Wywoływane po zakończeniu zadania ładowania z końcową aktualizacją LoadBundleTaskProgress . Aktualizacja zawsze będzie miała taskState ustawiony na "Success" .
onOdrzucony (a: Błąd) => R | ObiecajLike<R> Wywoływana, gdy podczas ładowania pakietu wystąpi błąd.

Zwroty:

Obietnica<T | R>