NAMESPACE STATIC
VERSION V3.6.1
类
NavigationRoute
NavigationRoute可以轻松创建匹配浏览器navigation requests的Route。
它仅匹配mode设置为navigate的请求。
您可以只使用blacklist和whitelist参数中的一个或两个,将此路由应用于导航请求中。
RegExpRoute
RegExpRoute可以轻松创建一个基于正则表达式的Route。
对于同源请求,正则只需要匹配部分URL。 对于针对第三方服务器的请求,您必须定义与URL的开头匹配的正则。
有关信息,请参阅模块文档。
Route
Route包含match和handler回调函数。match回调决定路由是否通过handler来处理请求。当匹配时调用handler回调并且应该返回一个解析为Response的Promise。
Router
如果存在匹配的路由,Router可以通过一个或多个Routes来响应请求。
如果没有匹配请求,在设置default的handle情况下会执行这个handle。
如果匹配的路由抛出错误,路由器将使用catch处理程序。如果定义了这个handle,它会执行并做出请求进行响应。
如果请求匹配多条路由,则最早注册的路由将用于响应请求。
方法
registerNavigationRoute
STATIC
registerNavigationRoute(cachedAssetUrl, options),返回workbox.routing.NavigationRoute
注册导航请求路由,会返回预缓存文件。对于App Shell模式是非常有用的。
这个方法会生成一个NavigationRoute并调用Router.registerRoute()。
参数
cachedAssetUrl
String。
options
可选,Object,包含以下属性:
- cacheName:可选,
string。缓存名,用来存储和获取请求。默认缓存名由workbox-core.cacheNames提供。 - blacklist:可选,
Array of RegExp。如果与任何一个匹配,则不会处理请求(即使白名单也匹配)。 - whitelist:可选,
Array of RegExp。如果URL的pathname和查询参数与任何一个匹配,则路由会处理请求(在黑名单未匹配的情况下)。
返回
workbox.routing.NavigationRoute 返回生成的路由。
registerRoute
STATIC
registerRoute(capture, handler, method)返回workbox.routing.Route。
使用缓存策略很轻松的注册RegExp,string, function路由。
如果需要,此方法会生成Route并调用Router.registerRoute() 。
参数
capture
如果捕获参数是Route,则将忽略所有其他参数。(RegExp,string,workbox.routing.Route~matchCallback,或者 workbox.routing.Route)
handler
workbox.routing.Route~handlerCallback
一个回调函数,它返回一个Response的Promise。
method
可选,string。用于匹配Route的HTTP方法。
返回
workbox.routing.Route,生成Route(对注销很用)。
setCatchHandler
STATIC
setCatchHandler(handler)。
如果在处理请求期间路由抛出错误,那么将调用此处理程序,并可以做出请求响应。
参数
handler
一个回调函数,它返回一个Response的Promise。
setDefaultHandler
STATIC
setDefaultHandler(handler)。
定义当没有路由匹配请求时调用的默认处理程序。
如果没有默认处理程序,则不匹配的请求将通过网络请求,就像没有service worker一样。
参数
handler
一个回调函数,它返回一个Response的Promise。
unregisterRoute
STATIC
unregisterRoute(route)。
注销路由。
参数
route
注销的路由。
博客名称:王乐平博客
CSDN博客地址:http://blog.csdn.net/lecepin