W3cubDocs

Cursor

Available on js

The IDBCursor interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database.

Documentation IDBCursor by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Variables

`read onlydirection:CursorDirection`

Returns the direction of traversal of the cursor. See Constants for possible values.

`read onlykey:Dynamic`

Returns the key for the record at the cursor's position. If the cursor is outside its range, this is set to undefined. The cursor's key can be any data type.

`read onlyprimaryKey:Dynamic`

Returns the cursor's current effective primary key. If the cursor is currently being iterated or has iterated outside its range, this is set to undefined. The cursor's primary key can be any data type.

`read onlysource:EitherType<ObjectStore, Index>`

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(count:Int):Void`

Sets the number times a cursor should move its position forward.

Throws:

`null`	DOMError

`continuePrimaryKey(key:Dynamic, primaryKey:Dynamic):Void`

Sets the cursor to the given index key and primary key given as arguments.

Throws:

`null`	DOMError

`continue_(?key:Dynamic):Void`

Advances the cursor to the next position along its direction, to the item whose key matches the optional key parameter.

Throws:

`null`	DOMError

`delete():Request`

Returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. This can be used to delete specific records.

Throws:

`null`	DOMError

`update(value:Dynamic):Request`

Returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. This can be used to update specific records.

Throws:

`null`	DOMError