advance

Summary

Advances the cursor by the specified number of records.

Method of apis/indexeddb/IDBCursorapis/indexeddb/IDBCursor

Syntax

 cursor.advance(count);

Parameters

count

Data-type

Number

A positive, non-zero integer value indicating the number of records to advance.

Return Value

No return value

Examples

var dbOpenRequest = window.indexedDB.open("BookShop1");
dbOpenRequest.onsuccess = function(event){
    var transaction = dbOpenRequest.result.transaction(["ObjectStore_BookList"], IDBTransaction.READ_WRITE);
    var objectStore = transaction.objectStore("ObjectStore_BookList");
    // Function to call when a new cursor is required
    var cursor = null;
    var request = objectStore.openCursor(IDBKeyRange.bound(0, new Date().getTime(), true, false), 1);
    request.onsuccess = function(event){
        cursor = request.result;
        write("Cursor opened", cursor);

        if (cursor) {
            write("Value in cursor now is ", cursor.key, cursor.value);
            cursor.advance(2); // jump 2 entries
        }

    };
};

View live example

Usage

 Throws an exception if

• The value passed into the count parameter was zero or a negative number.
• The transaction this IDBCursor belongs to is not active.
• The cursor is currently being iterated, or has iterated past its end.

Notes

Calling this method more than once before new cursor data has been loaded is not allowed and results in a DOMException of type InvalidStateError being thrown. For example, calling advance() twice from the same onsuccess handler results in a DOMException of type InvalidStateError being thrown on the second call.

Syntax

Related specifications

W3C IndexedDB Specification

W3C Proposed Recommendation

Attributions

• Microsoft Developer Network: [Windows Internet Explorer API reference Article]