IDBCursorWithValue.value

Baseline Widely available

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

IDBCursorWithValue インターフェイスの読み取り専用プロパティ value は、それが何であっても、現在のカーソルの値を返します。

メモ: この機能はウェブワーカー内で利用可能です。

値

現在のカーソルの値です。

例

この例では、トランザクションを作成し、オブジェクトストアを取得し、カーソルを用いてオブジェクトストア内の全レコードを走査します。それぞれの繰り返しで、カーソルの値を cursor.value で記録します。

カーソルを用いる場合、キーでデータを選択する必要は無く、単に全部取得できます。また、ループ中のそれぞれの繰り返しにおいて、カーソルオブジェクトが現在指しているレコードのデータを cursor.value.foo で取得できます。動く例全体は、IDBCursor example を参照してください。(動く例を見る)

js
function displayData() {
  const transaction = db.transaction(["rushAlbumList"], "readonly");
  const objectStore = transaction.objectStore("rushAlbumList");

  objectStore.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const listItem = document.createElement("li");
      listItem.textContent = `${cursor.value.albumTitle}, ${cursor.value.year}`;
      list.appendChild(listItem);

      console.log(cursor.value);
      cursor.continue();
    } else {
      console.log("全エントリーを表示しました。");
    }
  };
}

仕様書

Specification
Indexed Database API 3.0
# ref-for-dom-idbcursorwithvalue-value①

ブラウザーの互換性

BCD tables only load in the browser

関連情報