Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Storage.length a Storage.key(): počet položek a čtení názvů klíčů

`length` udává počet uložených položek a `key(index)` vrací název klíče podle jeho pozice. Pořadí klíčů není zaručeno.

Verze: Current web platform; runtime support varies

Syntaxe

// 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 označuje dva prvky instance Storage. Vlastnost storage.length je pouze pro čtení a udává aktuální počet dvojic klíč–hodnota, nikoli velikost v bajtech ani kvótu. Metoda storage.key(index) vrací název klíče jako řetězec, nikoli jeho hodnotu. Pozice začínají nulou: zadávejte nezáporné celé číslo v rozsahu unsigned long (od 0 do 2 ** 32 - 1). Pokud je převedený index větší nebo roven aktuální hodnotě length, metoda vrátí null.

Chcete-li přečíst hodnotu, předejte název metodě storage.getItem(name). I ta může vrátit null, ale v tomto případě to znamená, že daný klíč neexistuje. Výsledek key() kontrolujte pomocí name !== null, protože i prázdný řetězec může být platným názvem klíče.

Pořadí klíčů závisí na implementaci a po změně obsahu se může změnit. Nespoléhejte na pořadí vkládání a neukládejte index jako identifikátor klíče. Pokud záleží na pořadí zobrazení, shromážděte názvy a výslovně je seřaďte. Uložením hodnoty length nevznikne snímek úložiště: při změnách během procházení můžete některé klíče přeskočit nebo je projít dvakrát.

Rozhraní Web Storage definuje standard HTML, nikoli ECMAScript 2024. window.localStorage je vázáno na původ (origin) a může přetrvat restart prohlížeče. window.sessionStorage je navíc odděleno podle karty nebo okna nejvyšší úrovně: přetrvá opětovné načtení stránky, ale je vázáno na relaci stránky. Nepředpokládejte dostupnost v každém běhovém prostředí. Získání kteréhokoli objektu úložiště může vyvolat SecurityError kvůli neprůhlednému původu nebo pravidlům prohlížeče. Zápis může vyvolat QuotaExceededError, například při vyčerpání kvóty.

Příklady

(() => {
  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" },
    );
  }
})();

Výsledek

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

Spusťte kód v konzoli prohlížeče na stránce HTTP(S) v testovací kartě s prázdným a dostupným `sessionStorage`, které nemění žádný jiný kód. Díky seřazení výstup nezávisí na pořadí klíčů v prohlížeči. `key(count)` vrátí `null` a `finally` odebere pouze dvě položky použité v příkladu. Pro Node.js 24 uložte kód jako `main.js` a spusťte `node main.js`. V případě potřeby příklad povolí vestavěné rozhraní Web Storage v podřízeném procesu.

Související lekce

  • JavaScript · Lekce 42 · Pokročilá · Verze: 4

Zdroje