WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Storage.length und Storage.key(): Einträge zählen und Schlüsselnamen lesen

`length` zählt die gespeicherten Einträge, und `key(index)` liefert einen Schlüsselnamen anhand seiner Position. Die Reihenfolge ist nicht garantiert.

Version: Current web platform; runtime support varies

Syntax

// Web Storage is defined by the HTML Living Standard, not ECMAScript 2024.
storage.length                 // number (read-only)
storage.key(index)             // string | null; zero-based index
storage.getItem(name)          // string | null; lookup by key name

Storage.length/key bezeichnet zwei Elemente einer Storage-Instanz. Die schreibgeschützte Eigenschaft storage.length zählt die aktuell gespeicherten Schlüssel-Wert-Paare. Sie gibt weder die Größe in Bytes noch das Speicherlimit an. Die Methode storage.key(index) liefert den Schlüsselnamen als Zeichenkette, nicht seinen Wert. Die Positionen beginnen bei null: Übergib eine nichtnegative Ganzzahl im Bereich von unsigned long (0 bis 2 ** 32 - 1). Ist der konvertierte Index mindestens so groß wie length zum Zeitpunkt des Aufrufs, gibt die Methode null zurück.

Um den Wert zu lesen, übergib den Namen an storage.getItem(name). Auch diese Methode kann null zurückgeben; hier bedeutet es, dass der Schlüssel nicht vorhanden ist. Prüfe das Ergebnis von key() mit name !== null, denn auch die leere Zeichenkette kann ein gültiger Schlüsselname sein.

Die Reihenfolge hängt von der Implementierung ab und kann sich nach einer Änderung des Speichers ändern. Verlasse dich nicht auf die Einfügereihenfolge und speichere keinen Index als Schlüsselkennung. Wenn die Anzeigereihenfolge wichtig ist, sammle die Namen und sortiere sie ausdrücklich. Ein zwischengespeicherter length-Wert ist keine Momentaufnahme: Änderungen beim Durchlaufen können dazu führen, dass Schlüssel übersprungen oder zweimal besucht werden.

Web Storage ist im HTML-Standard definiert und gehört nicht zu ECMAScript 2024. window.localStorage ist an einen Origin gebunden und kann Browserneustarts überdauern. window.sessionStorage ist zusätzlich nach Tabs oder Fenstern der obersten Ebene getrennt: Die Daten bleiben beim Neuladen erhalten, sind aber an die Seitensitzung gebunden. Setze die Verfügbarkeit nicht in jeder Laufzeitumgebung voraus. Der Zugriff auf eines der Speicherobjekte kann bei einem opaken Origin oder aufgrund von Browsereinstellungen SecurityError auslösen; beim Schreiben kann etwa bei ausgeschöpftem Speicherlimit QuotaExceededError auftreten.

Beispiele

(() => {
  function demonstrate(storage) {
    if (storage.length !== 0) {
      throw new Error("Use an empty sessionStorage area.");
    }

    try {
      console.log(storage.length);
      storage.setItem("theme", "dark");
      storage.setItem("lang", "en");

      const count = storage.length;
      const names = [];
      for (let index = 0; index < count; index++) {
        const name = storage.key(index);
        if (name !== null) names.push(name);
      }

      console.log(count);
      console.log(JSON.stringify(names.sort().map(name => [name, storage.getItem(name)])));
      console.log(storage.key(count));
    } finally {
      storage.removeItem("theme");
      storage.removeItem("lang");
    }
  }

  const storage = globalThis.sessionStorage;
  if (storage !== undefined) {
    demonstrate(storage);
  } else {
    // If Node.js 24 has not exposed Web Storage, enable it in a fresh process.
    const { execFileSync } = require("node:child_process");
    execFileSync(
      process.execPath,
      ["--experimental-webstorage", "-e", `(${demonstrate.toString()})(globalThis.sessionStorage);`],
      { stdio: "inherit" },
    );
  }
})();

Ergebnis

0
2
[["lang","en"],["theme","dark"]]
null

Führe den Code in der Browserkonsole einer HTTP(S)-Seite in einem Test-Tab aus. `sessionStorage` muss leer und zugänglich sein und darf nicht von anderem Code geändert werden. Durch das Sortieren hängt die Ausgabe nicht von der Schlüsselreihenfolge des Browsers ab. `key(count)` ergibt `null`, und `finally` entfernt nur die beiden Einträge des Beispiels. Speichere den Code für Node.js 24 als `main.js` und führe `node main.js` aus. Bei Bedarf aktiviert das Beispiel die integrierte Web-Storage-API in einem Kindprozess.

Zugehörige Lektionen

  • JavaScript · Lektion 42 · Fortgeschritten · Version: 4

Quellen