WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Storage.removeItem — einen Eintrag entfernen

Die Methode removeItem(key) entfernt ein bestimmtes Schlüssel-Wert-Paar aus localStorage oder sessionStorage. Sie gibt undefined zurück; ein fehlender Schlüssel verursacht keinen Fehler.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

storage.removeItem(key)

Storage.removeItem ist eine synchrone Web-Storage-Methode, die im HTML Standard und nicht in ECMAScript definiert ist. Rufe sie auf localStorage oder sessionStorage auf und übergib den Schlüssel als Zeichenfolge. Alle gängigen Browser-Engines unterstützen die Methode, aber nicht jede Browser-Engine implementiert Web Storage. Dass Node 24 in einem Repository vorhanden ist, belegt keine Browserunterstützung.

removeItem(key) entfernt nur den angegebenen Eintrag und gibt undefined zurück, auch wenn der Schlüssel nicht existiert. Nach dem Entfernen gibt getItem(key) null zurück. Im Gegensatz dazu entfernt clear() alle Einträge aus dem ausgewählten Speicherbereich.

Bei einem tatsächlichen Entfernen wird für andere Dokumente, die denselben Speicherbereich verwenden, ein storage-Ereignis eingereiht, nicht jedoch für das Fenster, das den Vorgang ausführt; newValue ist null. Bei einem fehlenden Schlüssel wird kein Ereignis ausgelöst.

Der Zugriff auf window.localStorage oder window.sessionStorage kann eine SecurityError-Ausnahme auslösen, zum Beispiel aufgrund einer Browserrichtlinie. Das Beispiel versucht zunächst, window.sessionStorage zu verwenden. Tritt dabei SecurityError oder QuotaExceededError auf, verwendet es statt Web Storage ein Testobjekt, das die Daten in einer Map im Arbeitsspeicher hält. In beiden Fällen wählt das Beispiel einen unbenutzten Schlüssel, legt darunter einen temporären Eintrag an und entfernt ihn anschließend.

Beispiele

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Storage.removeItem: removing one entry</title>
</head>
<body>
<h1>Removing a storage entry</h1>
<p id="source"></p>
<script>
  function checkRemoval(storage) {
    let key = 'cktis:removeItem';
    while (storage.getItem(key) !== null) key += ':';

    try {
      storage.setItem(key, 'draft');
      const removed = storage.removeItem(key);
      const missing = storage.getItem(key) === null;
      const removedAgain = storage.removeItem(key);
      return [removed === undefined, missing, removedAgain === undefined && storage.getItem(key) === null];
    } finally {
      storage.removeItem(key);
    }
  }

  let lines;
  let source = 'Using browser sessionStorage.';
  try {
    lines = checkRemoval(window.sessionStorage);
  } catch (error) {
    if (error.name !== 'SecurityError' && error.name !== 'QuotaExceededError') throw error;
    source = 'Could not access browser sessionStorage or write the test entry. Using an in-memory fixture, not Web Storage.';
    const entries = new Map();
    lines = checkRemoval({
      getItem(key) { return entries.has(key) ? entries.get(key) : null; },
      setItem(key, value) { entries.set(key, String(value)); },
      removeItem(key) { entries.delete(key); }
    });
  }
  document.getElementById('source').textContent = source;
  for (const line of lines) console.log(line);
</script>
</body>
</html>

Ergebnis

true
true
true

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen