For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Interface IDBCursorWithValue
direction: IDBCursorDirection;
key: IDBValidKey;
primaryKey: IDBValidKey;
request: IDBRequest;
source: IDBObjectStore | IDBIndex;
value: any;
advance(count: number): void;
continue(key?: IDBValidKey): void;
continuePrimaryKey(key: IDBValidKey, primaryKey: IDBValidKey): void;
delete(): IDBRequest<undefined>;
update(value: any): IDBRequest<IDBValidKey>;
}
Hierarchy (View Summary)
- IDBCursor
- IDBCursorWithValue
Properties
Readonlydirection
The direction read-only property of the IDBCursor interface is a string that returns the direction of traversal of the cursor (set using IDBObjectStore.openCursor for example). See the Value section below for possible values.
Readonlykey
The key read-only property of the IDBCursor interface 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.
ReadonlyprimaryKey
The primaryKey read-only property of the IDBCursor interface returns the cursor's current effective 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.
Readonlyrequest
The request read-only property of the IDBCursor interface returns the IDBRequest used to obtain the cursor.
Readonlysource
The source read-only property of the IDBCursor interface returns the IDBObjectStore or IDBIndex that the cursor is iterating over. 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.
Readonlyvalue
The value read-only property of the IDBCursorWithValue interface returns the value of the current cursor, whatever that is.
Methods
advance
-
The
advance()method of the IDBCursor interface sets the number of times a cursor should move its position forward.Parameters
- count: number
Returns void
continue
-
The
continue()method of the IDBCursor interface advances the cursor to the next position along its direction, to the item whose key matches the optional key parameter. If no key is specified, the cursor advances to the immediate next position, based on its direction.Parameters
Optionalkey: IDBValidKey
Returns void
continuePrimaryKey
-
The
continuePrimaryKey()method of the IDBCursor interface advances the cursor to the item whose key matches the key parameter as well as whose primary key matches the primary key parameter.Parameters
- key: IDBValidKey
- primaryKey: IDBValidKey
Returns void
delete
-
The
delete()method of the IDBCursor interface 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.Returns IDBRequest<undefined>
update
-
The
update()method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. If the cursor points to a record that has just been deleted, a new record is created.Parameters
- value: any
Returns IDBRequest<IDBValidKey>
The
IDBCursorWithValueinterface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property.MDN Reference