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

CKTIS / JavaScript

Storage.getItem — ler um valor de Web Storage

Storage.getItem(key) lê texto de forma síncrona de localStorage ou sessionStorage. Devolve null quando a chave não existe; uma cadeia vazia é um valor existente, não uma entrada em falta.

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.getItem(key)

Storage.getItem é um método de instância de Storage, utilizado por localStorage e sessionStorage. Aceita uma chave de texto e devolve o texto guardado ou null se a entrada não existir. A leitura é síncrona e não remove a entrada.

Distingue null, "" e "null". Verifica a ausência com value === null, e não com !value, que também corresponde a uma cadeia vazia. Os números e objetos guardados não recuperam automaticamente os seus tipos.

Esta é uma API Web definida pelo HTML Living Standard, não uma funcionalidade de uma edição específica de ECMAScript. É amplamente suportada pelos browsers modernos; a versão de Node do repositório não comprova o suporte nos browsers. O próprio acesso a window.localStorage ou window.sessionStorage pode gerar um SecurityError devido a uma origem opaca ou à política do browser.

O exemplo distingue uma cadeia vazia, a cadeia "42" e uma entrada em falta. Escolhe uma chave que não está a ser usada e remove a entrada temporária para verificar se a leitura devolve null. O bloco finally repete a remoção para eliminar a entrada mesmo em caso de erro, sem limpar toda a área de armazenamento.

Exemplos

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Storage.getItem: empty and missing values</title>
</head>
<body>
<h1>Reading a storage value</h1>
<p id="source"></p>
<script>
  function readValues(storage) {
    let key = 'cktis:getItem';
    while (storage.getItem(key) !== null) key += ':';

    try {
      storage.setItem(key, '');
      const empty = storage.getItem(key);
      storage.setItem(key, '42');
      const text = storage.getItem(key);
      storage.removeItem(key);
      return [JSON.stringify(empty), JSON.stringify(text), storage.getItem(key) === null];
    } finally {
      storage.removeItem(key);
    }
  }

  let lines;
  let source = 'Using browser sessionStorage.';
  try {
    lines = readValues(window.sessionStorage);
  } catch (error) {
    if (error.name !== 'SecurityError' && error.name !== 'QuotaExceededError') throw error;
    source = error.name === 'QuotaExceededError'
      ? 'Could not write the demo value to sessionStorage. Existing entries may still be readable. Using an in-memory fixture, not Web Storage.'
      : 'Browser storage is unavailable. Using an in-memory fixture, not Web Storage.';
    const entries = new Map();
    lines = readValues({
      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

""
"42"
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