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.

IDBCursor

Summary

Iterates over object stores and indices.

Properties

direction
Indicates the direction of travel within a cursor.
key
The key value for the record currently displayed by the cursor.
primaryKey
Returns the cursor’s current effective key.
source
On getting, returns the IDBObjectStore or IDBIndex that the cursor is iterating. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

Methods

advance
Advances the cursor by the specified number of records.
continue
Moves to the next record, or to the record specified by a key.
delete
Returns an IDBRequest object and, in a separate thread, deletes the record at the cursor’s position, without changing the cursor’s position. Once the record is deleted, the cursor’s value is set to null.
update
Creates a structured clone of the value parameter.

Events

No events.

Related specifications

W3C IndexedDB Specification
W3C Proposed Recommendation

Attributions