База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

Storage.length и Storage.key(): броене на записи и четене на имена на ключове

`length` дава броя на записите, а `key(index)` връща името на ключ според позицията му. Редът на ключовете не е гарантиран.

Версия: Current web platform; runtime support varies

Синтаксис

// 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 обозначава два члена на обект Storage. Свойството storage.length е само за четене и връща текущия брой двойки ключ–стойност, а не размера в байтове или квотата. Методът storage.key(index) връща името на ключа като низ, а не стойността му. Позициите започват от нула: подавай неотрицателно цяло число в диапазона на unsigned long (от 0 до 2 ** 32 - 1). Ако преобразуваният индекс е по-голям от текущата стойност на length или е равен на нея, методът връща null.

За да прочетеш стойността, подай името на storage.getItem(name). Този метод също може да върне null, но тогава това означава, че ключът липсва. Проверявай резултата от key() с name !== null, защото празният низ също може да е валидно име на ключ.

Редът на ключовете зависи от реализацията и може да се промени след промяна в хранилището. Не разчитай на реда на добавяне и не запазвай индекс като идентификатор на ключ. Ако редът на показване е важен, събери имената и ги сортирай изрично. Запазването на length не създава моментна снимка: при промяна по време на обхождането някои ключове може да бъдат пропуснати или обходени два пъти.

Web Storage е дефиниран в стандарта HTML и не е част от ECMAScript 2024. window.localStorage е обвързан с произхода (origin) и може да се запази след рестартиране на браузъра. window.sessionStorage е отделен и за всеки раздел или прозорец от най-високо ниво: запазва се при презареждане, но е обвързан със сесията на страницата. Не приемай, че интерфейсът е достъпен във всяка среда за изпълнение. Получаването на който и да е от двата обекта може да предизвика SecurityError при непрозрачен произход или ограничение на браузъра. Записът може да предизвика QuotaExceededError, например при изчерпана квота.

Примери

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

Резултат

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

Изпълни кода в конзолата на браузъра на HTTP(S) страница в тестов раздел с празно и достъпно `sessionStorage`, което не се променя от друг код. Сортирането прави изхода независим от реда на ключовете в браузъра. `key(count)` връща `null`, а `finally` премахва само двата записа, използвани в примера. За Node.js 24 запази кода като `main.js` и изпълни `node main.js`; при нужда примерът активира вградения Web Storage в дъщерен процес.

Свързани уроци

  • JavaScript · Урок 42 · Напреднало · Версия: 4

Източници