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

CKTIS / JavaScript

Storage.clear() — remover todas as entradas

Storage.clear() remove sincronamente todos os pares chave-valor da área de Web Storage selecionada. Não recebe argumentos e devolve undefined. Atenção: também elimina entradas que não estão relacionadas com o seu código.

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.clear()

Storage.clear opera sobre um objeto Storage: localStorage.clear() limpa a área local da origem correspondente, enquanto sessionStorage.clear() limpa a área de sessão dessa origem e separador. Não limpa ambas ao mesmo tempo. Esta é uma API do padrão HTML, não de ECMAScript.

O método é síncrono, não recebe argumentos e devolve undefined. Uma área vazia mantém-se vazia. Para eliminar uma única entrada, use removeItem(key); clear() não filtra as chaves por prefixo.

A remoção de entradas coloca um evento storage na fila para os outros documentos elegíveis que partilham a área, mas não para o documento que fez a chamada. Os campos key, oldValue e newValue têm então o valor null. Uma área vazia não gera qualquer evento.

O acesso a window.localStorage ou window.sessionStorage pode lançar uma SecurityError, por exemplo, devido à política do navegador. No exemplo, o isolamento por sandbox dá ao iframe uma origem opaca. typeof Storage.prototype.clear devolve "function", mas a leitura de window.sessionStorage lança uma SecurityError antes de o código chamar clear(). Não é eliminada nenhuma entrada. Para testar uma chamada bem-sucedida a sessionStorage.clear(), use apenas um separador e uma origem reservados para testes: a chamada elimina todas as entradas da área de armazenamento da sessão, incluindo as anteriores.

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Storage.clear() and storage access</title>
</head>
<body>
  <script>
    const frame = document.createElement('iframe');
    frame.title = 'Isolated Storage.clear test';
    frame.setAttribute('sandbox', 'allow-scripts');
    frame.srcdoc = `<!doctype html>
<html lang="en">
<head><meta charset="utf-8"><title>Storage clear test</title></head>
<body>
  <p role="status"></p>
  <script>
    const methodType = typeof Storage.prototype.clear;
    const methodStatus = 'typeof Storage.prototype.clear: ' + methodType;
    let resultStatus;
    try {
      const storage = window.sessionStorage;
      storage.setItem('demo:color', 'blue');
      storage.setItem('demo:count', '2');
      const result = storage.clear();
      resultStatus = 'Remaining entries: ' + storage.length + '; return value: ' + String(result);
    } catch (error) {
      resultStatus = 'Clear not completed: ' + error.name;
    }
    document.querySelector('[role="status"]').textContent = methodStatus + '. ' + resultStatus;
    console.log(methodStatus);
    console.log(resultStatus);
  <\/script>
</body>
</html>`;
    document.body.append(frame);
  </script>
</body>
</html>

Resultado

typeof Storage.prototype.clear: function
Clear not completed: SecurityError

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