This page is Ready to Use

Notice: The WebPlatform project has been discontinued when the Stewards partnership agreement ended in September 2015. This site has been frozen, and the assets we have created will remain.

IDBIndex

Summary

A metadata index to a referenced object store.

Properties

keyPath
The key path of this index. If null, this index is not auto-populated.
multiEntry
Affects how the index behaves when the result of evaluating the index’s key path yields an array. If true, there is one record in the index for each item in an array of keys. If false, then there is one record for each key that is an array.
name
The name of this index.
objectStore
Returns a reference to the IDBObjectStore instance for the referenced object store in this IDBIndex’s transaction.
unique
Provides the unique flag of this index.

Methods

count
Runs the steps for asynchronously executing a request and returns the IDBRequest created by these steps.
get
Runs the steps for asynchronously executing a request and returns the IDBRequest created by these steps.
openCursor
Creates a cursor.
openKeyCursor
Creates a cursor.

Events

No events.

Related specifications

W3C IndexedDB Specification
W3C Proposed Recommendation

Attributions