Storage: removeItem() メソッド

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

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

構文

js
removeItem(keyName)

引数

keyName

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

返値

なし (undefined)。

例

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

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

  localStorage.removeItem("image");
}

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

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

  sessionStorage.removeItem("image");
}

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

仕様書

Specification
HTML Standard
# dom-storage-removeitem-dev

ブラウザーの互換性

BCD tables only load in the browser

関連情報