Class CursorIterator<T, IK, PK>

Do not instantiate this class directly, instead use ObjectStore.iterator or Index.iterator to get an instance of this class.

Type Parameters

T
IK extends IDBValidKey
PK extends IDBValidKey

Index

Constructors

Methods

iterateKeys iterateValues

Constructors

constructor

new CursorIterator<T, IK, PK>(cursorProvider): CursorIterator<T, IK, PK>
Do not instantiate this class directly, instead use ObjectStore.iterator or Index.iterator to get an instance of this class.
Type Parameters
- T
- IK extends IDBValidKey
- PK extends IDBValidKey
Parameters
- cursorProvider: CursorProvider
Returns CursorIterator<T, IK, PK>

Methods

iterateKeys

iterateKeys(action, options?): Promise<void>
Iterating over keys and primary keys. To update/delete, use iterateValues instead.
Parameters
- action: ((v) => Promise<boolean | void>)
  return true to break the iteration.
  - - (v): Promise<boolean | void>
    - Parameters
      v: CursorValue1<IK, PK>
      Returns Promise<boolean | void>
- Optional options: CursorIterationOption<IK, PK>
  see doc of CursorIterationOption to know how to use.
Returns Promise<void>

iterateValues

iterateValues(action, options?): Promise<void>
Iterating over key, primary keys and objects. You can also update or delete during iteration using CursorValue2.update or CursorValue2.delete.
Parameters
- action: ((v) => Promise<boolean | void>)
  return true to break the iteration.
  - - (v): Promise<boolean | void>
    - Parameters
      v: CursorValue2<T, IK, PK>
      Returns Promise<boolean | void>
- Optional options: CursorIterationOption<IK, PK>
  see doc of CursorIterationOption to know how to use.
Returns Promise<void>