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
- IDBCursor
- IDBCursorWithValue (View Summary)
Properties
Readonlydirection
Returns the direction ("next", "nextunique", "prev" or "prevunique") of the cursor.
Readonlykey
Returns the key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.
ReadonlyprimaryKey
Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.
Readonlyrequest
Readonlysource
Returns the IDBObjectStore or IDBIndex the cursor was opened from.
Readonlyvalue
Returns the cursor's current value.
Methods
advance
continue
- continue(key?: IDBValidKey): void
Advances the cursor to the next record in range.
Parameters
Optionalkey: IDBValidKey
Returns void
continuePrimaryKey
- continuePrimaryKey(key: IDBValidKey, primaryKey: IDBValidKey): void
Advances the cursor to the next record in range matching or after key and primaryKey. Throws an "InvalidAccessError" DOMException if the source is not an index.
Parameters
- key: IDBValidKey
- primaryKey: IDBValidKey
Returns void
delete
- delete(): IDBRequest<undefined>
Delete the record pointed at by the cursor with a new value.
If successful, request's result will be undefined.
Returns IDBRequest<undefined>
update
- update(value: any): IDBRequest<IDBValidKey>
Updated the record pointed at by the cursor with a new value.
Throws a "DataError" DOMException if the effective object store uses in-line keys and the key would have changed.
If successful, request's result will be the record's key.
Parameters
- value: any
Returns IDBRequest<IDBValidKey>
This IndexedDB API interface 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