Interface IDBCursorWithValue

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

interface IDBCursorWithValue {
    direction: IDBCursorDirection;
    key: IDBValidKey;
    primaryKey: IDBValidKey;
    request: IDBRequest<any>;
    source: IDBObjectStore | IDBIndex;
    value: any;
    advance(count): void;
    continue(key?): void;
    continuePrimaryKey(key, primaryKey): void;
    delete(): IDBRequest<undefined>;
    update(value): IDBRequest<IDBValidKey>;
}

Hierarchy (view full)

Properties

direction key primaryKey request source value

Methods

advance continue continuePrimaryKey delete update

Properties

Readonly direction

direction: IDBCursorDirection

Returns the direction ("next", "nextunique", "prev" or "prevunique") of the cursor.

MDN Reference

Readonly key

key: IDBValidKey

Returns the key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

MDN Reference

Readonly primaryKey

primaryKey: IDBValidKey

Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException if the cursor is advancing or is finished.

MDN Reference

Readonly request

request: IDBRequest<any>

MDN Reference

Readonly source

source: IDBObjectStore | IDBIndex

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

MDN Reference

Readonly value

value: any

Returns the cursor's current value.

MDN Reference

Methods

advance

  • advance(count): void

  • Advances the cursor through the next count records in range.

    MDN Reference

    Parameters

    • count: number

    Returns void

continue

  • continue(key?): void

  • Advances the cursor to the next record in range.

    MDN Reference

    Parameters

    Returns void

continuePrimaryKey

  • continuePrimaryKey(key, primaryKey): 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.

    MDN Reference

    Parameters

    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.

    MDN Reference

    Returns IDBRequest<undefined>

update

  • update(value): 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.

    MDN Reference

    Parameters

    • value: any

    Returns IDBRequest<IDBValidKey>

Settings

Member Visibility

Theme

On This Page

directionkeyprimaryKeyrequestsourcevalueadvancecontinuecontinuePrimaryKeydeleteupdate