BackgroundFetchRegistration
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("Background Fetch API")}}{{SeeCompatTable}}{{AvailableInWorkers}}
The **BackgroundFetchRegistration** interface of the {{domxref('Background Fetch API','','',' ')}} represents an individual background fetch.
A BackgroundFetchRegistration instance is returned by the {{domxref("BackgroundFetchManager.fetch()")}} or {{domxref("BackgroundFetchManager.get()")}} methods, and therefore there has no constructor.
{{InheritanceDiagram}}
Instance properties
_Also inherits properties from its parent, {{domxref("EventTarget")}}._
- {{domxref("BackgroundFetchRegistration.id")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A string containing the background fetch's ID.
- {{domxref("BackgroundFetchRegistration.uploadTotal")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A {{jsxref("Number")}} containing the total number of bytes to be uploaded.
- {{domxref("BackgroundFetchRegistration.uploaded")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A {{jsxref("Number")}} containing the size in bytes successfully sent, initially
0. - {{domxref("BackgroundFetchRegistration.downloadTotal")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A {{jsxref("Number")}} containing the total size in bytes of this download. This is the value set when the background fetch was registered, or
0. - {{domxref("BackgroundFetchRegistration.downloaded")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A {{jsxref("Number")}} containing the size in bytes that has been downloaded, initially
0. - {{domxref("BackgroundFetchRegistration.result")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : Returns an empty string initially, on completion either the string
"success"or"failure". - {{domxref("BackgroundFetchRegistration.failureReason")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A string with a value that indicates a reason for a background fetch failure. Can be one of the following values:
"","aborted","bad-status","fetch-error","quota-exceeded","download-total-exceeded". - {{domxref("BackgroundFetchRegistration.recordsAvailable")}} {{ReadOnlyInline}} {{Experimental_Inline}}
- : A {{jsxref("Boolean")}} indicating whether the
recordsAvailableflag is set.
Instance methods
_Also inherits methods from its parent, {{domxref("EventTarget")}}._
- {{domxref("BackgroundFetchRegistration.abort()")}} {{Experimental_Inline}}
- : Aborts the background fetch. Returns a {{jsxref("Promise")}} that resolves with
trueif the fetch was successfully aborted. - {{domxref("BackgroundFetchRegistration.match()")}} {{Experimental_Inline}}
- : Returns a single {{domxref("BackgroundFetchRecord")}} object which is the first match for the arguments.
- {{domxref("BackgroundFetchRegistration.matchAll()")}} {{Experimental_Inline}}
- : Returns a {{jsxref("Promise")}} that resolves with an array of {{domxref("BackgroundFetchRecord")}} objects containing requests and responses.
Events
_Also inherits events from its parent, {{domxref("EventTarget")}}._
Listen to these events using {{domxref("EventTarget.addEventListener", "addEventListener()")}} or by assigning an event listener to the oneventname property of this interface.
- {{domxref("BackgroundFetchRegistration/progress_event", "progress")}} {{Experimental_Inline}}
- : Fired when there is a change to any of the following properties:
{{domxref("BackgroundFetchRegistration.uploaded", "uploaded")}}, {{domxref("BackgroundFetchRegistration.downloaded", "downloaded")}}, {{domxref("BackgroundFetchRegistration.result", "result")}} or {{domxref("BackgroundFetchRegistration.failureReason", "failureReason")}}.
Examples
The following code creates a BackGroundFetchRegistration as bgFetch, with an id of "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,
},
);
});Logging the {{domxref("BackgroundFetchRegistration.id","id")}} to the console returns "my-fetch".
console.log(bgFetch.id); // "my-fetch"The {{domxref("BackgroundFetchRegistration.match","match()")}} method can be used to find a particular {{domxref("BackgroundFetchRecord")}} from those that are part of the registration.
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);
});Specifications
{{Specifications}}
Browser compatibility
{{Compat}}