BackgroundFetchRegistration

Интерфейс BackgroundFetchRegistration из API Background Fetch представляет собой отдельную фоновую загрузку.

Экземпляр BackgroundFetchRegistration возвращается методами BackgroundFetchManager.fetch() или BackgroundFetchManager.get(), поэтому у него нет конструктора.

Также наследует свойства от родительского класса, EventTarget.

BackgroundFetchRegistration.id Только для чтения Экспериментально

Строка, содержащая идентификатор фоновой загрузки.

BackgroundFetchRegistration.uploadTotal Только для чтения Экспериментально

number, содержащий общее количество байтов для загрузки.

BackgroundFetchRegistration.uploaded Только для чтения Экспериментально

number, содержащий размер в байтах успешно отправленной информации, по умолчанию 0.

BackgroundFetchRegistration.downloadTotal Только для чтения Экспериментально

number, содержащий общий размер в байтах данного скачивания. Это значение задается при регистрации фоновой загрузки, или 0.

BackgroundFetchRegistration.downloaded Только для чтения Экспериментально

number, содержащий размер в байтах, который был скачан, по умолчанию 0.

BackgroundFetchRegistration.result Только для чтения Экспериментально

Изначально возвращает пустую строку, по завершении — либо строку "success", либо "failure".

BackgroundFetchRegistration.failureReason Только для чтения Экспериментально

Строка со значением, указывающим причину сбоя фоновой загрузки. Может принимать следующие значения: "", "aborted", "bad-status", "fetch-error", "quota-exceeded", "download-total-exceeded".

BackgroundFetchRegistration.recordsAvailable Только для чтения Экспериментально

boolean, указывающий, установлен ли флаг recordsAvailable.

Также наследует методы от родительского класса, EventTarget.

BackgroundFetchRegistration.abort() Экспериментально

Прерывает фоновую загрузку. Возвращает Promise, который разрешается значением true в случае успешного прерывания загрузки.

BackgroundFetchRegistration.match() Экспериментально

Возвращает единственный объект BackgroundFetchRecord, который является первым совпадением по переданным аргументам.

BackgroundFetchRegistration.matchAll() Экспериментально

Возвращает Promise, который разрешается массивом объектов BackgroundFetchRecord, содержащих запросы и ответы.

Также наследует события от родительского класса, EventTarget.

Подписывайтесь на эти события с помощью addEventListener() или назначив обработчик событий свойству oneventname этого интерфейса.

progress Экспериментально

Срабатывает при изменении следующих свойств: uploaded, downloaded, result или failureReason.

Следующий код создаёт BackGroundFetchRegistration как bgFetch, с id равным "my-fetch".

navigator.serviceWorker.ready.then(async (swReg) => {
  const bgFetch = await swReg.backgroundFetch.fetch(
    "my-fetch",
    ["/ep-5.mp3", "ep-5-artwork.jpg"],
    {
      title: "Episode 5: Interesting things.",
      icons: [
        {
          sizes: "300x300",
          src: "/ep-5-icon.png",
          type: "image/png",
        },
      ],
      downloadTotal: 60 * 1024 * 1024,
    },
  );
});

Вывод id в консоль даёт "my-fetch".

console.log(bgFetch.id); // "my-fetch"

Метод match() может использоваться для поиска конкретного объекта BackgroundFetchRecord из тех, которые являются частью регистрации.

bgFetch.match("/ep-5.mp3").then(async (record) => {
  if (!record) {
    console.log("No record found");
    return;
  }

  console.log(`Here's the request`, record.request);
  const response = await record.responseReady;
  console.log(`And here's the response`, response);
});