Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Storage.removeItem — remover uma entrada

O método removeItem(key) remove um par chave-valor específico de localStorage ou sessionStorage. Devolve undefined; a ausência da chave não causa um erro.

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

Sintaxe

storage.removeItem(key)

Storage.removeItem é um método síncrono de Web Storage, definido pelo HTML Standard e não pelo ECMAScript. Chame-o em localStorage ou sessionStorage, passando a chave como uma cadeia de caracteres. Todos os principais motores de navegador suportam este método, mas nem todos os motores implementam Web Storage. A presença do Node 24 num repositório não comprova o suporte nos navegadores.

removeItem(key) remove apenas a entrada indicada e devolve undefined, mesmo que a chave não exista. Após a remoção, getItem(key) devolve null. Em contrapartida, clear() remove todas as entradas da área de armazenamento selecionada.

Uma remoção efetiva coloca um evento storage na fila para os outros documentos que partilham a área de armazenamento, mas não para a janela que executa a operação; newValue é null. Se a chave não existir, não é gerado qualquer evento.

O acesso a window.localStorage ou window.sessionStorage pode lançar uma exceção SecurityError, por exemplo, devido a uma política do navegador. O exemplo tenta primeiro usar window.sessionStorage. Se a tentativa lançar uma exceção SecurityError ou QuotaExceededError, utiliza um objeto de teste que guarda os dados em memória num Map, em vez de recorrer a Web Storage. Em ambos os casos, o exemplo escolhe uma chave que não está a ser usada, guarda uma entrada temporária com essa chave e depois remove-a.

Exemplos

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

Resultado

true
true
true

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes