預先快取

屬性

• deletedCacheRequests

  string[]

屬性

• notUpdatedURLs

  string[]

• updatedURLs

  string[]

屬性

• 建構函式

  void

  建立新的 PrecacheController。

  constructor 函式如下所示：

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

  • 選項

    PrecacheControllerOptions 選用

  • returns

    PrecacheController

• 策略

  策略

• 啟用

  void

  刪除已不在目前預先快取資訊清單中的資產。 從 Service Worker 啟用事件呼叫此方法。

  注意：這個方法會為您呼叫 event.waitUntil()，因此您不必在事件處理常式中自行呼叫。

  activate 函式如下所示：

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

  • event

    ExtendableEvent

  • returns

    Promise<CleanupResult>

• addToCacheList

  void

  這個方法會將項目新增至友善快取清單、移除重複內容，並確保資訊有效。

  addToCacheList 函式如下所示：

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

  • entries

    (字串 | PrecacheEntry)[]

    要友善載入的項目陣列。

• createHandlerBoundToURL

  void

  傳回在預快取中查詢 url 的函式 (擷取帳戶修訂版本資訊)，並傳回對應的 Response。

  createHandlerBoundToURL 函式如下所示：

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

  • 網址

    字串

    用於查詢 Response 的預先快取網址。

  • returns

    RouteHandlerCallback

• getCacheKeyForURL

  void

  傳回用來儲存特定網址的快取金鑰。如果該網址尚未版本 (例如「/index.html」)，快取金鑰就會是原始網址，並附有搜尋參數。

  getCacheKeyForURL 函式如下所示：

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

  • 網址

    字串

    您要查詢快取金鑰的網址。

  • returns

    字串

    版本化網址，與原始網址的快取金鑰相對應；如果沒有該網址的預快取，則為未定義。

• getCachedURLs

  void

  傳回目前 Service Worker 已預先快取的所有網址清單。

  getCachedURLs 函式如下所示：

  () => {...}

  • returns

    string[]

    友善快取網址。

• getIntegrityForCacheKey

  void

  getIntegrityForCacheKey 函式如下所示：

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

  • cacheKey

    字串

  • returns

    字串

    與快取金鑰相關聯的子資源完整性，如未設定，則為未定義。

• getURLsToCacheKeys

  void

  傳回友善快取網址與對應快取金鑰的對應，並將網址的修訂版本資訊納入考量。

  getURLsToCacheKeys 函式如下所示：

  () => {...}

  • returns

    地圖<stringstring>

    快取按鍵對應設定的網址。

• 安裝

  void

  預先快取新資產和更新資產。請從 Service Worker 的安裝事件呼叫此方法。

  注意：這個方法會為您呼叫 event.waitUntil()，因此您不必在事件處理常式中自行呼叫。

  install 函式如下所示：

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

  • event

    ExtendableEvent

  • returns

    Promise<InstallResult>

• matchPrecache

  void

  這可以做為 cache.match() 的直接取代，但以下差異：

  • 它知道預先快取名稱，並且只會在該快取中檢查。
  • 您可以在沒有版本管理參數的情況下，傳入「原始」網址，而且會自動查詢該網址目前使用中修訂版本的正確快取金鑰。

  例如：matchPrecache('index.html') 會尋找目前使用中 Service Worker 的正確預先快取回應，即使實際的快取金鑰是 '/index.html?__WB_REVISION__=1234abcd' 也一樣。

  matchPrecache 函式如下所示：

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

  • 申請。

    string | 要求

    用來在預先快取中查詢的金鑰 (不含修訂參數)。

  • returns

    Promise<Response>

• 預先快取

  void

  新增項目至友善快取清單、移除所有重複項目，並在服務工作站安裝時將檔案儲存在快取中。

  這個方法可以多次呼叫。

  precache 函式如下所示：

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

  • entries

    (字串 | PrecacheEntry)[]

屬性

• 完整性

  字串 選用

• 修訂版本

  字串 選用

• 網址

  字串

屬性

• 建構函式

  void

  使用相關聯的 backupURL 建構新的 PrecacheFallbackPlugin。

  constructor 函式如下所示：

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

  • config

    物件

    • fallbackURL

      字串

      在相關策略無法產生回應時，用來當做備用方案的預先快取網址。

    • precacheController

      PrecacheController 選用

  • returns

    PrecacheFallbackPlugin

屬性

• 建構函式

  void

  constructor 函式如下所示：

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

  • precacheController

    PrecacheController

    用於比對要求及回應擷取事件的 PrecacheController 執行個體。

  • 選項

    PrecacheRouteOptions 選用

  • returns

    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 選用

  • returns

    PrecacheStrategy

• cacheName

  字串

• fetchOptions

  RequestInit (選用)

• matchOptions

  CacheQueryOptions 選用

• 外掛程式

  WorkboxPlugin[]

• copyRedirectedCacheableResponsesPlugin

  WorkboxPlugin

• defaultPrecacheCacheabilityPlugin

  WorkboxPlugin

• _等待完成

  void

  _awaitComplete 函式如下所示：

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

  • responseDone

    Promise<Response>

  • handler

    StrategyHandler

  • 申請。

    要求

  • event

    ExtendableEvent

  • returns

    Promise<void>

• _取得回應

  void

  _getResponse 函式如下所示：

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

  • handler

    StrategyHandler

  • 申請。

    要求

  • event

    ExtendableEvent

  • returns

    Promise<Response>

• _帳號代碼

  void

  _handleFetch 函式如下所示：

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

  • 申請。

    要求

  • handler

    StrategyHandler

  • returns

    Promise<Response>

• _handle 安裝

  void

  _handleInstall 函式如下所示：

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

  • 申請。

    要求

  • handler

    StrategyHandler

  • returns

    Promise<Response>

• 帳號

  void

  執行要求策略並傳回會使用 Response 解析的 Promise，並叫用所有相關外掛程式回呼。

  透過 Workbox workbox-routing.Route 註冊策略執行個體時，系統會在路徑比對相符時自動呼叫這個方法。

  或者，您也可以將此方法傳遞至 event.respondWith()，以在獨立的 FetchEvent 事件監聽器中使用。

  handle 函式如下所示：

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

  • 選項

    FetchEvent | HandlerCallbackOptions

    FetchEvent 或具有下列屬性的物件。

  • returns

    Promise<Response>

• handleAll

  void

  與 workbox-strategies.Strategy~handle 類似，但前者不會傳回解析為 Response 的 Promise，而是會傳回 [response, done] 承諾組合，其中前者 (response) 等同於 handle() 傳回的內容，後者則是在執行策略的過程中，新增至 event.waitUntil() 的任何承諾，皆可解決問題。

  您可以等待 done 承諾，確保策略執行的所有額外工作 (通常是快取回應) 都能順利完成。

  handleAll 函式如下所示：

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

  • 選項

    FetchEvent | HandlerCallbackOptions

    FetchEvent 或具有下列屬性的物件。

  • returns

    [Promise<Response>, Promise<void>]

    [response, finished] 的組合，可用於判斷回應解析的時間，以及處理常式完成所有作業的時間。

類型

參數

• { 網址 }

  物件

  • 網址

    網址

傳回

• 網址 []

參數

• 外掛程式

  WorkboxPlugin[]

參數

• 選項

  PrecacheRouteOptions 選用

參數

• 網址

  字串

  用於查詢 Response 的預先快取網址。

傳回

• RouteHandlerCallback

參數

• 網址

  字串

  要查詢其快取金鑰的網址。

傳回

• string | 未定義

  與該網址對應的快取金鑰。

參數

• 申請。

  string | 要求

  用來在預先快取中查詢的金鑰 (不含修訂參數)。

傳回

• Promise<Response | undefined>

參數

• entries

  (字串 | PrecacheEntry)[]

參數

• entries

  (字串 | PrecacheEntry)[]

  要友善載入的項目陣列。

• 選項

  PrecacheRouteOptions 選用