LoadBundleTask class

Представляет задачу загрузки пакета Firestore. Он отображает ход загрузки пакета, а также события завершения задач и ошибок.

API совместим с Promise<LoadBundleTaskProgress> .

Подпись:

export declare class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress> 

Реализует: PromiseLike< LoadBundleTaskProgress >

Методы

Метод Модификаторы Описание
поймать (onRejected) Реализует интерфейс 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>;

Параметры

Параметр Тип Описание
onRejected (а: Ошибка) => R | ОбещаниеLike<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>;

Параметры

Параметр Тип Описание
onВыполнено (а: ЛоадБундлеТаскПрогресс ) => Т | ОбещаниеLike<T> Вызывается по завершении задачи загрузки с окончательным обновлением LoadBundleTaskProgress . В обновлении для taskState всегда будет установлено значение "Success" .
onRejected (а: Ошибка) => R | ОбещаниеLike<R> Вызывается, когда возникает ошибка во время загрузки пакета.

Возврат:

Обещание<T | Р>