CookieStore.delete()
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
CookieStore
インターフェイスの delete()
メソッドは、与えられた名前またはオプションオブジェクトを持つ Cookie を削除します(下記参照)。delete()
メソッドは日付を過去のものに変更することで Cookie を失効させます。
構文
var promise = cookieStore.delete(name);
var promise = cookieStore.delete(options);
引数
このメソッドは、以下のいずれかが必要です。
name
-
Cookie の名前が入っている
USVString
です。 - オプション
-
オブジェクトは次のものを含みます。
メモ: url
オプションは、特定の URL をスコープとした Cookie の変更を可能にします。サービスワーカーは、自分のスコープ下にある任意の URL に送信される Cookie を取得できます。ドキュメントからは現在の URL の Cookie しか取得できないので、ドキュメントコンテキストで有効な URL はドキュメントの URL のみとなります。
返値
例外
TypeError
-
与えられた
name
やoptions
で表される Cookie の削除に失敗した場合にスローされます。
例
この例では、delete()
メソッドに名前を渡すことで、Cookie を削除しています。
let result = cookieStore.delete('cookie1');
console.log(result);
仕様書
Specification |
---|
Cookie Store API # dom-cookiestore-delete |
ブラウザーの互換性
BCD tables only load in the browser