CookieStore: delete() メソッド
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
delete() は CookieStore インターフェイスのメソッドで、与えられた名前またはオプションオブジェクトを持つ Cookie を削除します（下記参照）。delete() メソッドは日付を過去のものに変更することで Cookie を失効させます。
構文
delete(name)
delete(options)
引数
このメソッドは、以下のいずれかが必要です。
name-
Cookie の名前が入っている文字列です。
または
options-
オブジェクトは以下のプロパティを含みます。
name-
Cookie の名前が入っている文字列です。
partitioned省略可-
論理値で、既定値は
falseです。trueに設定すると、削除するクッキーがパーティション化 Cookie であることを表します。詳しくは Cookies Having Independent Partitioned State (CHIPS) を参照してください。 path省略可-
パスを含む文字列です。
url省略可-
Cookie の URL が入っている文字列です。
メモ: 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 |