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
The direction read-only property of the direction of traversal of the cursor (set using section below for possible values.
Readonlykey
The key read-only property of the position.
ReadonlyprimaryKey
The primaryKey read-only property of the cursor is currently being iterated or has iterated outside its range, this is set to undefined.
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 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 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.Parameters
Optionalkey: IDBValidKey
Returns void
continuePrimaryKey
The
continuePrimaryKey()method of the 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.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.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.MDN Reference