Storage:key() 方法

Baseline 已廣泛支援

此特性已相當成熟,可在許多裝置和瀏覽器版本上使用。自 ⁨2015 年 7 月⁩以來,各瀏覽器均已提供此特性。

Storage 介面的 key() 方法,當傳入數字 n 時,返回給定 Storage 物件中第 n 個鍵的名稱。鍵的順序由使用者代理定義,因此你不應該依賴它。

語法

js
key(index)

引數

index

一個整數,表示你想要獲取名稱的鍵的編號。這是一個從零開始的索引。

返回值

包含鍵名稱的字串。如果索引不存在,則返回 null

示例

以下函式迭代本地儲存(local storage)中的鍵:

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

以下函式迭代本地儲存(local storage)中的鍵並獲取每個鍵設定的值:

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

注意: 有關實際示例,請參閱我們的Web Storage 演示

規範

規範
HTML
# dom-storage-key-dev

瀏覽器相容性

另見