workbox-core
Summary
- Types
- Properties
- Methods
Types
CacheDidUpdateCallback
workbox-core.CacheDidUpdateCallback(
param:
CacheDidUpdateCallbackParam,
)
Parameters
Returns
Promise<void>
CacheDidUpdateCallbackParam
Properties
- cacheName
string
- event
ExtendableEvent
- newResponse
Response
- oldResponse
Response optional
- request
Request
- state
MapLikeObject optional
CachedResponseWillBeUsedCallback
workbox-core.CachedResponseWillBeUsedCallback(
param:
CachedResponseWillBeUsedCallbackParam,
)
Parameters
Returns
Promise<void | Response>
CachedResponseWillBeUsedCallbackParam
Properties
- cacheName
string
- cachedResponse
Response optional
- event
ExtendableEvent
- matchOptions
CacheQueryOptions optional
- request
Request
- state
MapLikeObject optional
CacheKeyWillBeUsedCallback
workbox-core.CacheKeyWillBeUsedCallback(
param:
CacheKeyWillBeUsedCallbackParam,
)
Parameters
Returns
Promise<string | Request>
CacheKeyWillBeUsedCallbackParam
Properties
- event
ExtendableEvent
- mode
string
- params
any optional
- request
Request
- state
MapLikeObject optional
CacheWillUpdateCallback
workbox-core.CacheWillUpdateCallback(
param:
CacheWillUpdateCallbackParam,
)
Parameters
Returns
Promise<void | Response>
CacheWillUpdateCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- response
Response
- state
MapLikeObject optional
FetchDidFailCallback
workbox-core.FetchDidFailCallback(
param:
FetchDidFailCallbackParam,
)
Parameters
Returns
Promise<void>
FetchDidFailCallbackParam
Properties
- error
Error
- event
ExtendableEvent
- originalRequest
Request
- request
Request
- state
MapLikeObject optional
FetchDidSucceedCallback
workbox-core.FetchDidSucceedCallback(
param:
FetchDidSucceedCallbackParam,
)
Parameters
Returns
Promise<Response>
FetchDidSucceedCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- response
Response
- state
MapLikeObject optional
HandlerCallbackOptions
HandlerDidCompleteCallback
workbox-core.HandlerDidCompleteCallback(
param:
HandlerDidCompleteCallbackParam,
)
Parameters
Returns
Promise<void>
HandlerDidCompleteCallbackParam
Properties
- error
Error optional
- event
ExtendableEvent
- request
Request
- response
Response optional
- state
MapLikeObject optional
HandlerDidErrorCallback
workbox-core.HandlerDidErrorCallback(
param:
HandlerDidErrorCallbackParam,
)
Parameters
Returns
Promise<Response>
HandlerDidErrorCallbackParam
Properties
- error
Error
- event
ExtendableEvent
- request
Request
- state
MapLikeObject optional
HandlerDidRespondCallback
workbox-core.HandlerDidRespondCallback(
param:
HandlerDidRespondCallbackParam,
)
Parameters
Returns
Promise<void>
HandlerDidRespondCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- response
Response optional
- state
MapLikeObject optional
HandlerWillRespondCallback
workbox-core.HandlerWillRespondCallback(
param:
HandlerWillRespondCallbackParam,
)
Parameters
Returns
Promise<Response>
HandlerWillRespondCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- response
Response
- state
MapLikeObject optional
HandlerWillStartCallback
workbox-core.HandlerWillStartCallback(
param:
HandlerWillStartCallbackParam,
)
Parameters
Returns
Promise<void>
HandlerWillStartCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- state
MapLikeObject optional
ManualHandlerCallback
workbox-core.ManualHandlerCallback(
options:
ManualHandlerCallbackOptions,
)
The "handler" callback is invoked whenever a Router matches a URL/Request to a Route via its RouteMatchCallback. This handler callback should return a Promise that resolves with a Response.
If a non-empty array or object is returned by the RouteMatchCallback it will be passed in as this handler's options.params argument.
Parameters
- options
Returns
Promise<Response>
ManualHandlerCallbackOptions
Options passed to a ManualHandlerCallback function.
Properties
- event
ExtendableEvent
- request
string | Request
MapLikeObject
PluginState
Using a plain MapLikeObject for now, but could extend/restrict this in the future.
Type
RequestWillFetchCallback
workbox-core.RequestWillFetchCallback(
param:
RequestWillFetchCallbackParam,
)
Parameters
Returns
Promise<Request>
RequestWillFetchCallbackParam
Properties
- event
ExtendableEvent
- request
Request
- state
MapLikeObject optional
RouteHandler
Either a RouteHandlerCallback or a RouteHandlerObject. Most APIs in workbox-routing that accept route handlers take either.
RouteHandlerCallback
workbox-core.RouteHandlerCallback(
options:
RouteHandlerCallbackOptions,
)
The "handler" callback is invoked whenever a Router matches a URL/Request to a Route via its RouteMatchCallback. This handler callback should return a Promise that resolves with a Response.
If a non-empty array or object is returned by the RouteMatchCallback it will be passed in as this handler's options.params argument.
Parameters
- options
Returns
Promise<Response>
RouteHandlerCallbackOptions
Options passed to a RouteHandlerCallback function.
Properties
- event
ExtendableEvent
- params
string[] | MapLikeObject optional
- request
Request
- url
URL
RouteHandlerObject
An object with a handle method of type RouteHandlerCallback.
A Route object can be created with either an RouteHandlerCallback function or this RouteHandler object. The benefit of the RouteHandler is it can be extended (as is done by the workbox-strategies package).
Properties
- handle
RouteMatchCallback
workbox-core.RouteMatchCallback(
options:
RouteMatchCallbackOptions,
)
The "match" callback is used to determine if a Route should apply for a particular URL and request. When matching occurs in response to a fetch event from the client, the event object is also supplied. However, since the match callback can be invoked outside of a fetch event, matching logic should not assume the event object will always be available. If the match callback returns a truthy value, the matching route's RouteHandlerCallback will be invoked immediately. If the value returned is a non-empty array or object, that value will be set on the handler's options.params argument.
Parameters
- options
Returns
any
RouteMatchCallbackOptions
Options passed to a RouteMatchCallback function.
Properties
- event
ExtendableEvent
- request
Request
- sameOrigin
boolean
- url
URL
WorkboxPlugin
An object with optional lifecycle callback properties for the fetch and cache operations.
Properties
- cacheDidUpdate
CacheDidUpdateCallback optional
- cacheKeyWillBeUsed
CacheKeyWillBeUsedCallback optional
- cacheWillUpdate
CacheWillUpdateCallback optional
- cachedResponseWillBeUsed
CachedResponseWillBeUsedCallback optional
- fetchDidFail
FetchDidFailCallback optional
- fetchDidSucceed
FetchDidSucceedCallback optional
- handlerDidComplete
HandlerDidCompleteCallback optional
- handlerDidError
HandlerDidErrorCallback optional
- handlerDidRespond
HandlerDidRespondCallback optional
- handlerWillRespond
HandlerWillRespondCallback optional
- handlerWillStart
HandlerWillStartCallback optional
- requestWillFetch
RequestWillFetchCallback optional
WorkboxPluginCallbackParam
Properties
- cacheDidUpdate
- cacheKeyWillBeUsed
- cacheWillUpdate
- cachedResponseWillBeUsed
- fetchDidFail
- fetchDidSucceed
- handlerDidComplete
- handlerDidError
- handlerDidRespond
- handlerWillRespond
- handlerWillStart
- requestWillFetch
Properties
cacheNames
Get the current cache names and prefix/suffix used by Workbox.
cacheNames.precache is used for precached assets, cacheNames.googleAnalytics is used by workbox-google-analytics to store analytics.js, and cacheNames.runtime is used for everything else.
cacheNames.prefix can be used to retrieve just the current prefix value. cacheNames.suffix can be used to retrieve just the current suffix value.
Type
object
Properties
- googleAnalytics
string
- precache
string
- prefix
string
- runtime
string
- suffix
string
Methods
clientsClaim
workbox-core.clientsClaim()
Claim any currently available clients once the service worker becomes active. This is normally used in conjunction with skipWaiting().
copyResponse
workbox-core.copyResponse(
response:
Response,
modifier?:
function,
)
Allows developers to copy a response and modify its headers, status, or statusText values (the values settable via a [ResponseInit]https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#Syntax object in the constructor). To modify these values, pass a function as the second argument. That function will be invoked with a single object with the response properties {headers, status, statusText}. The return value of this function will be used as the ResponseInit for the new Response. To change the values either modify the passed parameter(s) and return it, or return a totally new object.
This method is intentionally limited to same-origin responses, regardless of whether CORS was used or not.
Parameters
- response
Response
- modifier
function optional
The
modifierparameter looks like:(responseInit: ResponseInit) => ResponseInit- responseInit
ResponseInit
- returns
ResponseInit
Returns
Promise<Response>
registerQuotaErrorCallback
workbox-core.registerQuotaErrorCallback(
callback:
Function,
)
Adds a function to the set of quotaErrorCallbacks that will be executed if there's a quota error.
Parameters
- callback
Function
setCacheNameDetails
workbox-core.setCacheNameDetails(
details:
PartialCacheNameDetails,
)
Modifies the default cache names used by the Workbox packages. Cache names are generated as <prefix>-<Cache Name>-<suffix>.
Parameters
- details
PartialCacheNameDetails
skipWaiting
workbox-core.skipWaiting()
This method is deprecated, and will be removed in Workbox v7.
Calling self.skipWaiting() is equivalent, and should be used instead.