Esta página foi traduzida do inglês pela comunidade. Saiba mais e junte-se à comunidade MDN Web Docs.

View in English Always switch to English

Storage.key()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨julho de 2015⁩.

O método key() da interface Storage, quando passado um número n, retorna o nome da n-ésima chave no dado objeto Storage. A ordem das chaves é definida pelo user-agent, então não deve-se confiar nela.

Syntax

var aKeyName = storage.key(index);

Parâmetros

index

Um inteiro representando o número da chave que deseja obter. Esse é um índice que começa em zero.

Retorno

Uma DOMString contendo o nome da chave. Se o index não existir, retornará null.

Exemplos

A função a seguir itera sobre as chaves do armazenamento local:

js
function forEachKey(callback) {
  for (var i = 0; i < localStorage.length; i++) {
    callback(localStorage.key(i));
  }
}

A função a seguir itera sobre as chaves do armazenamento local e obtém o valor de cada chave:

js
for (var i = 0; i < localStorage.length; i++) {
  console.log(localStorage.getItem(localStorage.key(i)));
}

Nota: Pra ver um exemplo real, consulte nossa Demonstração de armazenamento na Web.

Especificações

Specification
HTML
# dom-storage-key-dev

Compatibilidade com navegadores

Veja também