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

CKTIS / JavaScript

Storage: contar entradas e ler nomes de chaves

Storage disponibiliza pares de chaves e valores sob a forma de cadeias de caracteres através de localStorage e sessionStorage. Aprende a diferença entre Storage.length, que conta entradas, e Storage.key(index), que devolve o nome de uma chave, não o seu valor.

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.length
storage.key(index)
storage.getItem(key)
storage.setItem(key, value)
storage.removeItem(key)
storage.clear()

Storage é uma interface da Web API definida por HTML, não por ECMAScript. Podes obter os seus objetos através de window.localStorage ou window.sessionStorage. O primeiro destina-se a armazenar dados para além da sessão atual; o segundo está associado à sessão e à origem de um separador. As chaves e os valores são cadeias de caracteres.

Storage.length é só de leitura: indica o número de pares, não o respetivo tamanho em bytes. Numa chamada a Storage.key(index), Web IDL começa por converter o argumento para o tipo unsigned long. O método usa o valor convertido como índice de base zero e devolve o nome de uma chave, ou null se esse índice for maior ou igual a length. Por exemplo, storage.key(2 ** 32) usa o índice 0 e devolve o nome de uma chave se o armazenamento não estiver vazio. Para ler o valor, usa getItem(key).

A ordem das chaves não é especificada e pode mudar quando há alterações. Não pressuponhas uma ordem de inserção nem removas entradas enquanto percorres os índices. Para uma apresentação reproduzível, reúne os nomes e ordena-os.

O acesso pode gerar SecurityError e a escrita pode gerar QuotaExceededError. Trata estes erros nas aplicações. O exemplo tenta primeiro usar window.sessionStorage. Se intercetar SecurityError ou QuotaExceededError, usa um armazenamento de teste em memória em vez de Web Storage e apresenta o mesmo resultado na consola. A presença de Node 24 num repositório não comprova o suporte desta Web API.

Exemplos

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Storage: counting entries and reading key names</title>
</head>
<body>
<h1>Counting storage entries and listing their keys</h1>
<p id="source"></p>
<script>
  function inspectStorage(storage) {
    const names = ['cktis:storage:a', 'cktis:storage:b'].map(base => {
      let name = base;
      let suffix = 0;
      while (storage.getItem(name) !== null) name = `${base}:${++suffix}`;
      return name;
    });
    const written = [];
    try {
      const before = storage.length;
      for (const [index, value] of ['10', '20'].entries()) {
        storage.setItem(names[index], value);
        written.push(names[index]);
      }

      const count = storage.length;
      const keys = [];
      for (let index = 0; index < count; index++) {
        const name = storage.key(index);
        if (names.includes(name)) keys.push(name);
      }
      return [count - before, keys.length, storage.key(count) === null];
    } finally {
      for (const name of written) storage.removeItem(name);
    }
  }

  let lines;
  let source = 'Using browser sessionStorage.';
  try {
    lines = inspectStorage(window.sessionStorage);
  } catch (error) {
    if (error.name !== 'SecurityError' && error.name !== 'QuotaExceededError') throw error;
    source = 'The browser storage test write is unavailable. Using an in-memory fixture for this demonstration.';
    const entries = new Map();
    lines = inspectStorage({
      get length() { return entries.size; },
      key(index) { return Array.from(entries.keys())[index] ?? null; },
      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

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