diff options
Diffstat (limited to 'files/ja/web/api/cache/keys')
-rw-r--r-- | files/ja/web/api/cache/keys/index.html | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/files/ja/web/api/cache/keys/index.html b/files/ja/web/api/cache/keys/index.html new file mode 100644 index 0000000000..4dc981c901 --- /dev/null +++ b/files/ja/web/api/cache/keys/index.html @@ -0,0 +1,92 @@ +--- +title: Cache.keys() +slug: Web/API/Cache/keys +tags: + - API + - Cache + - Method + - Reference + - Service Workers + - ServiceWorker + - keys +translation_of: Web/API/Cache/keys +--- +<p>{{APIRef("Service Workers API")}}</p> + +<p><span class="seoSummary">{{domxref("Cache")}} インターフェイスの <strong><code>keys()</code></strong> メソッドは、{{domxref("Cache")}} キーの配列に解決される {{jsxref("Promise")}} を返します。</span></p> + +<p>リクエストは、挿入されたのと同じ順序で返されます。</p> + +<div class="note"> +<p><strong>注</strong>: レスポンスに <code>VARY</code> ヘッダーが設定されている場合、URL が重複しているがヘッダーが異なるリクエストを返すことができます。</p> +</div> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox"><em>cache</em>.keys(<em>request</em>, {<em>options</em>}).then(function(<em>keys</em>) { + // リクエストの配列で何かをする +}); +</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<dl> + <dt>request {{optional_inline}}</dt> + <dd>特定のキーが必要な場合、返してほしい {{domxref("Request")}}。 これは、<code>Request</code> オブジェクトまたは URL です。</dd> + <dt>options {{optional_inline}}</dt> + <dd>プロパティが <code>keys</code> 操作でどのように照合するかを制御するオブジェクト。 使用可能なオプションは次のとおりです。 + <ul> + <li><code>ignoreSearch</code>: 照合操作で URL のクエリ文字列を無視するかどうかを指定する {{jsxref("Boolean")}}。 <code>true</code> に設定すると、<code>http://foo.com/?value=bar</code> の <code>?value=bar</code> 部分を、照合の実行時に無視します。 デフォルトは <code>false</code> です。</li> + <li><code>ignoreMethod</code>: <code>true</code> に設定すると、照合操作が {{domxref("Request")}} <code>HTTP</code> メソッドを検証しないようにする {{jsxref("Boolean")}}(通常、<code>GET</code> および <code>HEAD</code> のみが許可されます)。 デフォルトは <code>false</code> です。</li> + <li><code>ignoreVary</code>: <code>true</code> に設定すると、<code>VARY</code> ヘッダーを照合しないように照合操作に指示する {{jsxref("Boolean")}}。 つまり、URL が一致した場合は、{{domxref("Response")}} オブジェクトに <code>VARY</code> ヘッダーがあるかどうかに関係なく一致します。 デフォルトは <code>false</code> です。</li> + <li><code>cacheName</code>: 検索対象の特定のキャッシュを表す {{domxref("DOMString")}}。 このオプションは <code>Cache.keys()</code> によって無視されることに注意してください。</li> + </ul> + </dd> +</dl> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p>{{domxref("Cache")}} キーの配列に解決される {{jsxref("Promise")}}。</p> + +<h2 id="Examples" name="Examples">例</h2> + +<pre class="brush: js">caches.open('v1').then(function(cache) { + cache.keys().then(function(keys) { + keys.forEach(function(request, index, array) { + cache.delete(request); + }); + }); +})</pre> + +<h2 id="Specifications" name="Specifications">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Service Workers', '#dom-cache-keys', 'Cache: keys')}}</td> + <td>{{Spec2('Service Workers')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div> + + +<p>{{Compat("api.Cache.keys")}}</p> +</div> + +<h2 id="See_also" name="See_also">関連情報</h2> + +<ul> + <li><a href="/ja/docs/Web/API/Service_Worker_API/Using_Service_Workers">Service worker の使用</a></li> + <li>{{domxref("Cache")}}</li> + <li>{{domxref("WorkerGlobalScope.caches")}}</li> +</ul> |