Storage: removeItem() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨2015年7月⁩.

removeItem() は Storage インターフェイスのメソッドは、キーの名前を渡すと、指定された Storage からキーを削除します。 Storage はウェブストレージ API のインターフェイスで、特定のドメインのセッションストレージまたはローカルストレージへのアクセス機能を提供します。

指定されたキーに関連するアイテムがない場合、このメソッドは何もしません。

構文

removeItem(keyName)

引数

keyName: 削除したいキーの名前を持つ文字列です。

返値

なし (undefined)。

例

以下の関数はローカルストレージに 3 個のデータ項目を作成した後、データ項目 image を削除します。

function populateStorage() {
 localStorage.setItem("bgcolor", "red");
 localStorage.setItem("font", "Helvetica");
 localStorage.setItem("image", "myCat.png");
 localStorage.removeItem("image");
}

セッションストレージについても同じことができます。

function populateStorage() {
 sessionStorage.setItem("bgcolor", "red");
 sessionStorage.setItem("font", "Helvetica");
 sessionStorage.setItem("image", "myCat.png");
 sessionStorage.removeItem("image");
}

メモ: 現実世界のの例として、Web Storage Demo をご覧ください。