Skip to content

@vite-pwa/workbox-swkit/core ​

Package

Declaration: @vite-pwa/workbox-swkit/core

Function Summary ​

NameDescription
clientsClaim
copyResponse
registerQuotaErrorCallback
setCacheNameDetails
skipWaiting

Interface Summary ​

TypeDescription
CacheDidUpdateCallback
CacheDidUpdateCallbackParam
CachedResponseWillBeUsedCallback
CachedResponseWillBeUsedCallbackParam
CacheKeyWillBeUsedCallback
CacheKeyWillBeUsedCallbackParam
CacheWillUpdateCallback
CacheWillUpdateCallbackParam
FetchDidFailCallback
FetchDidFailCallbackParam
FetchDidSucceedCallback
FetchDidSucceedCallbackParam
HandlerDidCompleteCallback
HandlerDidCompleteCallbackParam
HandlerDidErrorCallback
HandlerDidErrorCallbackParam
HandlerDidRespondCallback
HandlerDidRespondCallbackParam
HandlerWillRespondCallback
HandlerWillRespondCallbackParam
HandlerWillStartCallback
HandlerWillStartCallbackParam
ManualHandlerCallback 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.
ManualHandlerCallbackOptions Options passed to a ManualHandlerCallback function.
MapLikeObject
RequestWillFetchCallback
RequestWillFetchCallbackParam
RouteHandlerCallback 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.
RouteHandlerCallbackOptions Options passed to a RouteHandlerCallback function.
RouteHandlerObject An object with a handle method of type RouteHandlerCallback.
RouteMatchCallback 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.
RouteMatchCallbackOptions Options passed to a RouteMatchCallback function.
WorkboxPlugin An object with optional lifecycle callback properties for the fetch and cache operations.
WorkboxPluginCallbackParam

Type Alias Summary ​

NameDescription
HandlerCallbackOptions
PluginState Using a plain MapLikeObject for now, but could extend/restrict this in the future.
RouteHandler Either a RouteHandlerCallback or a RouteHandlerObject. Most APIs in workbox-routing that accept route handlers take either.

Variable Summary ​

NameDescription
cacheNames Get the current cache names and prefix/suffix used by Workbox.

Released under the MIT License.