Interface IDBIndex

Readonly keyPath

Readonly multiEntry

name

Readonly objectStore

Readonly unique

count

• count(query?): IDBRequest<number>

• Retrieves the number of records matching the given key or key range in query.

  If successful, request's result will be the count.

  MDN Reference

  Parameters

  • Optional query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<number>

get

• get(query): IDBRequest<any>

• Retrieves the value of the first record matching the given key or key range in query.

  If successful, request's result will be the value, or undefined if there was no matching record.

  MDN Reference

  Parameters

  • query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<any>

getAll

• getAll(query?, count?): IDBRequest<any[]>

• Retrieves the values of the records matching the given key or key range in query (up to count if given).

  If successful, request's result will be an Array of the values.

  MDN Reference

  Parameters

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional count: number

  Returns IDBRequest<any[]>

getAllKeys

• getAllKeys(query?, count?): IDBRequest<IDBValidKey[]>

• Retrieves the keys of records matching the given key or key range in query (up to count if given).

  If successful, request's result will be an Array of the keys.

  MDN Reference

  Parameters

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional count: number

  Returns IDBRequest<IDBValidKey[]>

getKey

• getKey(query): IDBRequest<IDBValidKey>

• Retrieves the key of the first record matching the given key or key range in query.

  If successful, request's result will be the key, or undefined if there was no matching record.

  MDN Reference

  Parameters

  • query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<IDBValidKey>

openCursor

• openCursor(query?, direction?): IDBRequest<IDBCursorWithValue>

• Opens a cursor over the records matching query, ordered by direction. If query is null, all records in index are matched.

  If successful, request's result will be an IDBCursorWithValue, or null if there were no matching records.

  MDN Reference

  Parameters

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional direction: IDBCursorDirection

  Returns IDBRequest<IDBCursorWithValue>

openKeyCursor

• openKeyCursor(query?, direction?): IDBRequest<IDBCursor>

• Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in index are matched.

  If successful, request's result will be an IDBCursor, or null if there were no matching records.

  MDN Reference

  Parameters

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional direction: IDBCursorDirection

  Returns IDBRequest<IDBCursor>