工作区预缓存

属性

• deletedCacheRequests

  字符串[]

属性

• notUpdatedURLs

  字符串[]

• updatedURLs

  字符串[]

属性

• 构造函数

  void

  创建一个新的 PrecacheController。

  constructor 函数如下所示：

  (options?: PrecacheControllerOptions) => {...}

  • 选项

    PrecacheControllerOptions 可选

  • 返回

    PrecacheController

• 策略

  策略

• 启用

  void

  删除当前预缓存清单中不再存在的资产。从 Service Worker 的激活事件中调用此方法。

  注意：此方法会为您调用 event.waitUntil()，因此您无需在事件处理脚本中自行调用它。

  activate 函数如下所示：

  (event: ExtendableEvent) => {...}

  • event

    ExtendableEvent

  • 返回

    Promise<CleanupResult>

• addToCacheList

  void

  此方法会将项添加到预缓存列表中，从而移除重复项并确保信息有效。

  addToCacheList 函数如下所示：

  (entries: (string | PrecacheEntry)[]) => {...}

  • entries

    （字符串 | PrecacheEntry）[]

    要预缓存的条目数组。

• createHandlerBoundToURL

  void

  返回一个函数，该函数在预缓存中查找 url（考虑修订信息），并返回相应的 Response。

  createHandlerBoundToURL 函数如下所示：

  (url: string) => {...}

  • 网址

    string

    将用于查找 Response 的预缓存网址。

  • 返回

    RouteHandlerCallback

• getCacheKeyForURL

  void

  返回用于存储指定网址的缓存键。如果该网址不带版本信息（例如“/index.html”），则缓存键将是原始网址并附加一个搜索参数。

  getCacheKeyForURL 函数如下所示：

  (url: string) => {...}

  • 网址

    string

    您要查找其缓存键的网址。

  • 返回

    string

    与原始网址的缓存键对应的版本化网址，如果未预缓存该网址，则为未定义的网址。

• getCachedURLs

  void

  返回已由当前 Service Worker 预缓存的所有网址的列表。

  getCachedURLs 函数如下所示：

  () => {...}

  • 返回

    字符串[]

    预缓存的网址。

• getIntegrityForCacheKey

  void

  getIntegrityForCacheKey 函数如下所示：

  (cacheKey: string) => {...}

  • cacheKey

    string

  • 返回

    string

    与缓存键关联的子资源完整性，如果未设置，则为未定义。

• getURLsToCacheKeys

  void

  返回预缓存网址到相应缓存键的映射，并考虑网址的修订版本信息。

  getURLsToCacheKeys 函数如下所示：

  () => {...}

  • 返回

    地图<字符串>

    用于缓存键映射的网址。

• 安装

  void

  预缓存新资产和更新后的资产。从 Service Worker 安装事件调用此方法。

  注意：此方法会为您调用 event.waitUntil()，因此您无需在事件处理脚本中自行调用它。

  install 函数如下所示：

  (event: ExtendableEvent) => {...}

  • event

    ExtendableEvent

  • 返回

    Promise<InstallResult>

• matchPrecache

  void

  它可以直接替换 cache.match()，但存在以下差异：

  • 它知道预缓存的名称，并且只会签入该缓存。
  • 它允许您传入不带版本控制参数的“原始”网址，并且它会自动为该网址的当前有效修订版本查找正确的缓存键。

  例如，即使实际缓存键为 '/index.html?__WB_REVISION__=1234abcd'，matchPrecache('index.html') 也会为当前处于活跃状态的 Service Worker 找到正确的预缓存响应。

  matchPrecache 函数如下所示：

  (request: string | Request) => {...}

  • request

    字符串 | 请求

    要在预缓存中查找的键（无需修改参数）。

  • 返回

    Promise<Response>

• 预缓存

  void

  在 Service Worker 安装时，将项添加到预缓存列表中，移除所有重复项并将文件存储在缓存中。

  此方法可多次调用。

  precache 函数如下所示：

  (entries: (string | PrecacheEntry)[]) => {...}

  • entries

    （字符串 | PrecacheEntry）[]

属性

• 完整性

  字符串（可选）

• 修订版本

  字符串（可选）

• 网址

  string

属性

• 构造函数

  void

  使用关联的 fallback网址 构造一个新的 PrecacheFallbackPlugin。

  constructor 函数如下所示：

  (config: object) => {...}

  • config

    对象

    • fallbackURL

      string

      预缓存的网址，在关联的策略无法生成响应时用作后备网址。

    • precacheController

      PrecacheController 可选

  • 返回

    PrecacheFallbackPlugin

属性

• 构造函数

  void

  constructor 函数如下所示：

  (precacheController: PrecacheController, options?: PrecacheRouteOptions) => {...}

  • precacheController

    PrecacheController

    一个 PrecacheController 实例，用于匹配请求和响应提取事件。

  • 选项

    PrecacheRouteOptions 可选

  • 返回

    PrecacheRoute

• catchHandler

  RouteHandlerObject 可选

• handler

  RouteHandlerObject

• 匹配

  RouteMatchCallback

• method

  HTTPMethod

• setCatchHandler

  void

  setCatchHandler 函数如下所示：

  (handler: RouteHandler) => {...}

  • handler

    RouteHandler

    一个回调函数，用于返回一个解析为响应的 Promise

属性

• cleanURLs

  布尔值 选填

• directoryIndex

  字符串（可选）

• ignoreURLParametersMatching

  RegExp[] 可选

• urlManipulation

  urlManipulation 可选

属性

• 构造函数

  void

  constructor 函数如下所示：

  (options?: PrecacheStrategyOptions) => {...}

  • 选项

    PrecacheStrategyOptions 可选

  • 返回

    PrecacheStrategy

• cacheName

  string

• fetchOptions

  RequestInit（可选）

• matchOptions

  CacheQueryOptions 可选

• 插件

  WorkboxPlugin[]

• copyRedirectedCacheableResponsesPlugin

  WorkboxPlugin

• defaultPrecacheCacheabilityPlugin

  WorkboxPlugin

• _awaitComplete

  void

  _awaitComplete 函数如下所示：

  (responseDone: Promise<Response>, handler: StrategyHandler, request: Request, event: ExtendableEvent) => {...}

  • responseDone

    Promise<Response>

  • handler

    StrategyHandler

  • request

    请求

  • event

    ExtendableEvent

  • 返回

    Promise<void>

• _getResponse

  void

  _getResponse 函数如下所示：

  (handler: StrategyHandler, request: Request, event: ExtendableEvent) => {...}

  • handler

    StrategyHandler

  • request

    请求

  • event

    ExtendableEvent

  • 返回

    Promise<Response>

• _handleFetch

  void

  _handleFetch 函数如下所示：

  (request: Request, handler: StrategyHandler) => {...}

  • request

    请求

  • handler

    StrategyHandler

  • 返回

    Promise<Response>

• _handleInstall

  void

  _handleInstall 函数如下所示：

  (request: Request, handler: StrategyHandler) => {...}

  • request

    请求

  • handler

    StrategyHandler

  • 返回

    Promise<Response>

• 标识名

  void

  执行请求策略，并返回将通过 Response 进行解析的 Promise，从而调用所有相关插件回调。

  使用 Workbox workbox-routing.Route 注册策略实例时，系统会在路由匹配时自动调用此方法。

  或者，您可以将此方法传递给 event.respondWith()，从而在独立的 FetchEvent 监听器中使用该方法。

  handle 函数如下所示：

  (options: FetchEvent | HandlerCallbackOptions) => {...}

  • 选项

    FetchEvent | HandlerCallbackOptions

    FetchEvent 或具有下列属性的对象。

  • 返回

    Promise<Response>

• handleAll

  void

  与 workbox-strategies.Strategy~handle 类似，但并非仅返回一个解析为 Response 的 Promise，而是返回一个 [response, done] promise 的元组，其中前一个 (response) 等同于 handle() 返回的内容，而后一个是 promise，会在执行策略过程中添加到 event.waitUntil() 的任何 promise 完成后进行解析。

  您可以等待 done promise，以确保策略执行的任何额外工作（通常是缓存响应）成功完成。

  handleAll 函数如下所示：

  (options: FetchEvent | HandlerCallbackOptions) => {...}

  • 选项

    FetchEvent | HandlerCallbackOptions

    FetchEvent 或具有下列属性的对象。

  • 返回

    [Promise<Response>, Promise<void>]

    [response, complete] 元组 promise 可用于确定响应何时解析，以及处理程序何时完成所有工作。

类型

参数

• { 网址 }

  对象

  • 网址

    网址

返回

• 网址 []

参数

• 插件

  WorkboxPlugin[]

参数

• 选项

  PrecacheRouteOptions 可选

参数

• 网址

  string

  将用于查找 Response 的预缓存网址。

返回

• RouteHandlerCallback

参数

• 网址

  string

  要获取其缓存键的网址。

返回

• 字符串 | 未定义

  与该网址对应的缓存键。

参数

• request

  字符串 | 请求

  要在预缓存中查找的键（无需修改参数）。

返回

• Promise<Response | undefined>

参数

• entries

  （字符串 | PrecacheEntry）[]

参数

• entries

  （字符串 | PrecacheEntry）[]

  要预缓存的条目数组。

• 选项

  PrecacheRouteOptions 可选