Interface IDBCursor

This IndexedDB API interface represents a cursor for traversing or iterating over multiple records in a database.

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

Properties

direction key primaryKey request source

Methods

advance continue continuePrimaryKey delete update

Properties

Readonly direction

direction: IDBCursorDirection

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

Readonly key

key: IDBValidKey

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 request

request: IDBRequest<any>

Readonly source

source: IDBObjectStore | IDBIndex

Returns the IDBObjectStore or IDBIndex the cursor was opened from.

Methods

advance

  • advance(count): void

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

    Parameters

    • count: number

    Returns void

continue

  • continue(key?): void

  • Advances the cursor to the next record in range.

    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.

    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.

    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.

    Parameters

    • value: any

    Returns IDBRequest<IDBValidKey>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc