ワークボックスのプレキャッシュ

プロパティ

• deletedCacheRequests

  string[]

プロパティ

• notUpdatedURLs

  string[]

• updatedURLs

  string[]

プロパティ

• コンストラクタ

  void

  新しい PrecacheController を作成します。

  constructor 関数は次のようになります。

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

  • オプション

    PrecacheControllerOptions（省略可）

  • 戻り値

    PrecacheController

• ストラテジー

  戦略

• activate

  void

  現在のプリキャッシュ マニフェストに存在しないアセットを削除します。このメソッドは、サービス ワーカーのアクティベーション イベントから呼び出します。

  注: このメソッドは event.waitUntil() を自動的に呼び出すため、イベント ハンドラで自分で呼び出す必要はありません。

  activate 関数は次のようになります。

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

  • イベント

    ExtendableEvent

  • 戻り値

    Promise<CleanupResult>

• addToCacheList

  void

  この方法では、アイテムをプリキャッシュ リストに追加し、重複を削除して、情報が有効であることを確認します。

  addToCacheList 関数は次のようになります。

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

  • entries

    （文字列 | PrecacheEntry）[]

    プリキャッシュするエントリの配列。

• createHandlerBoundToURL

  void

  プリキャッシュで url を検索し、対応する Response を返す関数を返します（リビジョン情報を考慮）。

  createHandlerBoundToURL 関数は次のようになります。

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

  • URL

    文字列

    Response の検索に使用されるプリキャッシュ URL。

  • 戻り値

    RouteHandlerCallback

• getCacheKeyForURL

  void

  特定の URL の保存に使用されたキャッシュキーを返します。その URL がバージョンなし（「/index.html」など）の場合、キャッシュキーは検索パラメータが追加された元の URL になります。

  getCacheKeyForURL 関数は次のようになります。

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

  • URL

    文字列

    キャッシュキーを検索する URL。

  • 戻り値

    文字列

    元の URL のキャッシュキーに対応するバージョニングされた URL。その URL がプリキャッシュされていない場合は未定義です。

• getCachedURLs

  void

  現在のサービス ワーカーによってプリキャッシュされたすべての URL のリストを返します。

  getCachedURLs 関数は次のようになります。

  () => {...}

  • 戻り値

    string[]

    プリキャッシュされた URL。

• getIntegrityForCacheKey

  void

  getIntegrityForCacheKey 関数は次のようになります。

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

  • cacheKey

    文字列

  • 戻り値

    文字列

    キャッシュキーに関連付けられたサブリソースの完全性。設定されていない場合は未定義です。

• getURLsToCacheKeys

  void

  URL のリビジョン情報を考慮して、事前キャッシュに保存された URL と対応するキャッシュキーのマッピングを返します。

  getURLsToCacheKeys 関数は次のようになります。

  () => {...}

  • 戻り値

    Map<stringstring>

    キーマッピングをキャッシュに保存する URL。

• インストール

  void

  新規および更新されたアセットをプリキャッシュします。このメソッドは、サービス ワーカーのインストール イベントから呼び出します。

  注: このメソッドは event.waitUntil() を自動的に呼び出すため、イベント ハンドラで自分で呼び出す必要はありません。

  install 関数は次のようになります。

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

  • イベント

    ExtendableEvent

  • 戻り値

    Promise<InstallResult>

• matchPrecache

  void

  これは cache.match() の代替として使用できますが、次の点が異なります。

  • プリキャッシュの名前を認識し、そのキャッシュのみをチェックインします。
  • バージョニング パラメータなしで「元の」URL を渡すことができ、その URL の現在アクティブなリビジョンの正しいキャッシュキーが自動的に検索されます。

  例: matchPrecache('index.html') は、実際のキャッシュキーが '/index.html?__WB_REVISION__=1234abcd' であっても、現在アクティブな Service Worker の正しいプリキャッシュ レスポンスを検出します。

  matchPrecache 関数は次のようになります。

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

  • リクエスト

    文字列 | リクエスト

    プリキャッシュで検索するキー（リビジョン パラメータなし）。

  • 戻り値

    Promise<Response>

• precache

  void

  サービス ワーカーがインストールされると、アイテムをプリキャッシュ リストに追加し、重複を削除してファイルをキャッシュに保存します」

  このメソッドは複数回呼び出すことができます。

  precache 関数は次のようになります。

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

  • entries

    （文字列 | PrecacheEntry）[]

プロパティ

• 完全性

  文字列 省略可

• リビジョン

  文字列 省略可

• URL

  文字列

プロパティ

• コンストラクタ

  void

  関連付けられた fallbackURL を使用して新しい PrecacheFallbackPlugin を構築します。

  constructor 関数は次のようになります。

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

  • config

    オブジェクト

    • fallbackURL

      文字列

      関連付けられた戦略でレスポンスを生成できない場合に、フォールバックとして使用するプリキャッシュ URL。

    • 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

    Response に解決する Promise を返すコールバック関数

プロパティ

• cleanURLs

  ブール値（省略可）

• directoryIndex

  文字列 省略可

• ignoreURLParametersMatching

  RegExp[] 省略可

• urlManipulation

  urlManipulation（省略可）

プロパティ

• コンストラクタ

  void

  constructor 関数は次のようになります。

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

  • オプション

    PrecacheStrategyOptions（省略可）

  • 戻り値

    PrecacheStrategy

• cacheName

  文字列

• 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

  • リクエスト

    リクエスト

  • イベント

    ExtendableEvent

  • 戻り値

    Promise<void>

• _getResponse

  void

  _getResponse 関数は次のようになります。

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

  • handler

    StrategyHandler

  • リクエスト

    リクエスト

  • イベント

    ExtendableEvent

  • 戻り値

    Promise<Response>

• _handleFetch

  void

  _handleFetch 関数は次のようになります。

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

  • リクエスト

    リクエスト

  • handler

    StrategyHandler

  • 戻り値

    Promise<Response>

• _handleInstall

  void

  _handleInstall 関数は次のようになります。

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

  • リクエスト

    リクエスト

  • 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 の Tuple を返します。前者（response）は handle() が返すものに相当し、後者は、戦略の実行の一環として event.waitUntil() に追加された Promise が完了すると解決する Promise です。

  done プロミスを待機して、戦略によって実行される追加作業（通常はレスポンスのキャッシュ保存）が正常に完了することを確認できます。

  handleAll 関数は次のようになります。

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

  • オプション

    FetchEvent | HandlerCallbackOptions

    FetchEvent または、次のプロパティを持つオブジェクト。

  • 戻り値

    [Promise<Response>, Promise<void>]

    [response, done] の Promise のタプル。レスポンスが解決したときや、ハンドラがすべての処理を完了したときに使用できます。

タイプ

パラメータ

• { url }

  オブジェクト

  • URL

    URL

戻り値

• URL[]

パラメータ

• プラグイン

  WorkboxPlugin[]

パラメータ

• オプション

  PrecacheRouteOptions（省略可）

パラメータ

• URL

  文字列

  Response の検索に使用されるプリキャッシュ URL。

戻り値

• RouteHandlerCallback

パラメータ

• URL

  文字列

  キャッシュキーを検索する URL。

戻り値

• 文字列 | 未定義

  その URL に対応するキャッシュキー。

パラメータ

• リクエスト

  文字列 | リクエスト

  プリキャッシュで検索するキー（リビジョン パラメータなし）。

戻り値

• Promise<Response | undefined>

パラメータ

• entries

  （文字列 | PrecacheEntry）[]

パラメータ

• entries

  （文字列 | PrecacheEntry）[]

  プリキャッシュするエントリの配列。

• オプション

  PrecacheRouteOptions（省略可）