Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

IDBCursor

IDBCursor: { constructor: any; prototype: IDBCursor }

Type declaration

  • constructor: function
    • Returns IDBCursor

  • prototype: IDBCursor

Readonly direction

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

Readonly key

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

Readonly primaryKey

primaryKey: IDBValidKey

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

Readonly source

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

Readonly value

value: any

Returns the cursor's current value.

Methods

advance

  • advance(count: number): void
  • Advances the cursor through the next count records in range.

    Parameters

    • count: number

    Returns void

continue

  • Advances the cursor to the next record in range.

    Parameters

    Returns void

continuePrimaryKey

  • 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

    Returns void

delete

  • Delete the record pointed at by the cursor with a new value.

    If successful, request's result will be undefined.

    Returns IDBRequest<undefined>

update

  • 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>

Generated using TypeDoc