Storage: Methode key()

Baseline Widely available

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

Die key()-Methode der Storage-Schnittstelle gibt, wenn sie mit einer Zahl n aufgerufen wird, den Namen des n-ten Schlüssels in einem gegebenen Storage-Objekt zurück. Die Reihenfolge der Schlüssel wird vom Benutzeragenten definiert, daher sollten Sie sich nicht darauf verlassen.

Syntax

js
key(index)

Parameter

index

Eine ganze Zahl, die die Nummer des Schlüssels darstellt, dessen Namen Sie erhalten möchten. Dies ist ein nullbasierter Index.

Rückgabewert

Ein String, der den Namen des Schlüssels enthält. Wenn der Index nicht existiert, wird null zurückgegeben.

Beispiele

Die folgende Funktion iteriert über die Schlüssel des lokalen Speichers:

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

Die folgende Funktion iteriert über die Schlüssel des lokalen Speichers und ruft den für jeden Schlüssel gesetzten Wert ab:

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

Hinweis: Für ein Praxisbeispiel siehe unser Web Storage Demo.

Spezifikationen

Specification
HTML Standard
# dom-storage-key-dev

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch