Class

Methods

addPlugins

static

addPlugins(newPlugins)

Add plugins to precaching.

Parameter

newPlugins

Array of Object

addRoute

static

addRoute(options)

Add a fetch listener to the service worker that will respond to network requests with precached assets.

Requests for assets that aren't precached, the FetchEvent will not be responded to, allowing the event to fall through to other fetch event listeners.

Parameter

options

Object

Values in options have the following properties:

Parameter

directoryIndex

Optional

string

The directoryIndex will check cache entries for a URLs ending with '/' to see if there is a hit when appending the directoryIndex value.

ignoreUrlParametersMatching

Optional

Array of RegExp

An array of regex's to remove search params when looking for a cache match.

cleanUrls

Optional

boolean

The cleanUrls option will check the cache for the URL with a .html added to the end of the end.

urlManipulation

Optional

workbox.precaching~urlManipulation

This is a function that should take a URL and return an array of alternative URL's that should be checked for precache matches.

precache

static

precache(entries)

Add items to the precache list, removing any duplicates and store the files in the "precache cache" when the service worker installs.

This method can be called multiple times.

Please note: This method will not serve any of the cached files for you, it only precaches files. To respond to a network request you call addRoute().

If you have a single array of files to precache, you can just call precacheAndRoute().

Parameter

entries

Array of (Object or string)

Array of entries to precache.

precacheAndRoute

static

precacheAndRoute(entries, options)

This method will add entries to the precache list and add a route to respond to fetch events.

This is a convenience method that will call precache() and addRoute() in a single call.

Parameter

entries

Array of (Object or string)

Array of entries to precache.

options

Object

See addRoute() options.

suppressWarnings

static

suppressWarnings(suppress)

Warnings will be logged if any of the precached assets are entered without a revision property. This is extremely dangerous if the URL's aren't revisioned. However, the warnings can be supressed with this method.

Parameter

suppress

boolean

Abstract types

CleanupResult

static

Object

Properties

Parameter

deletedCacheRequests

Array of string

List of URLs that were deleted from the precache cache.

deletedRevisionDetails

Array of string

List of URLs that were deleted from the precache cache.

InstallResult

static

Object

Properties

Parameter

updatedEntries

Array of (module:workbox-precaching.PrecacheController.PrecacheEntry or string)

List of entries supplied for precaching that were precached.

notUpdatedEntries

Array of (module:workbox-precaching.PrecacheController.PrecacheEntry or string)

List of entries supplied for precaching that were already precached.

PrecacheEntry

static

Object

Properties

Parameter

url

string

URL to precache.

revision

string

Revision information for the URL.

urlManipulation

inner

urlManipulation(context) returns Array of URL

The "urlManipulation" callback can be used to determine if there are any additional permutations of a URL that should be used to check against the available precached files.

For example, Workbox supports checking for '/index.html' when the URL '/' is provided. This callback allows additional, custom checks.

Parameter

context

Object

Values in context have the following properties:

Parameter

url

URL

The request's URL.

Returns

Array of URL To add additional urls to test, return an Array of URL's. Please note that these should not be Strings, but URL objects.