Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

Storage.removeItem — usuwanie jednego wpisu

Metoda removeItem(key) usuwa wskazaną parę klucz–wartość z localStorage lub sessionStorage. Zwraca undefined; brak klucza nie powoduje błędu.

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

Składnia

storage.removeItem(key)

Storage.removeItem to synchroniczna metoda Web Storage, zdefiniowana w HTML Standard, nie w ECMAScript. Wywołuj ją na localStorage lub sessionStorage, przekazując klucz jako ciąg znaków. Obsługują ją wszystkie główne silniki przeglądarek, ale nie każdy silnik obsługuje Web Storage. Obecność Node 24 w repozytorium nie potwierdza obsługi przeglądarkowej.

removeItem(key) usuwa tylko wskazany wpis i zwraca undefined, również gdy klucz nie istnieje. Po usunięciu getItem(key) zwraca null. Natomiast clear() usuwa wszystkie wpisy z wybranego magazynu.

Rzeczywiste usunięcie kolejkuje zdarzenie storage dla innych dokumentów współdzielących magazyn, nie dla okna wykonującego operację; newValue wynosi null. Brak klucza nie wywołuje zdarzenia.

Dostęp do window.localStorage lub window.sessionStorage może zgłosić SecurityError, na przykład wskutek polityki przeglądarki. Przykład najpierw próbuje użyć window.sessionStorage. Jeśli ta próba zakończy się błędem SecurityError lub QuotaExceededError, przykład używa obiektu testowego opartego na Map, który przechowuje dane w pamięci, a nie w Web Storage. W obu przypadkach przykład wybiera nieużywany klucz, zapisuje pod nim tymczasowy wpis, a następnie go usuwa.

Przykłady

<!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>

Wynik

true
true
true

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła