Interface IDBIndex
keyPath: string | string[];
multiEntry: boolean;
name: string;
objectStore: IDBObjectStore;
unique: boolean;
count(query?: IDBValidKey | IDBKeyRange): IDBRequest<number>;
get(query: IDBValidKey | IDBKeyRange): IDBRequest;
getAll(
query?: IDBValidKey | IDBKeyRange,
count?: number,
): IDBRequest<any[]>;
getAllKeys(
query?: IDBValidKey | IDBKeyRange,
count?: number,
): IDBRequest<IDBValidKey[]>;
getKey(query: IDBValidKey | IDBKeyRange): IDBRequest<IDBValidKey>;
openCursor(
query?: IDBValidKey | IDBKeyRange,
direction?: IDBCursorDirection,
): IDBRequest<IDBCursorWithValue>;
openKeyCursor(
query?: IDBValidKey | IDBKeyRange,
direction?: IDBCursorDirection,
): IDBRequest<IDBCursor>;
}
Index
Properties
Methods
Properties
ReadonlykeyPath
ReadonlymultiEntry
name
Returns the name of the index.
ReadonlyobjectStore
Returns the IDBObjectStore the index belongs to.
Readonlyunique
Methods
count
- count(query?: IDBValidKey | IDBKeyRange): 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.
Parameters
Optionalquery: IDBValidKey | IDBKeyRange
Returns IDBRequest<number>
get
- get(query: IDBValidKey | IDBKeyRange): IDBRequest
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.
Parameters
- query: IDBValidKey | IDBKeyRange
Returns IDBRequest
getAll
- getAll(query?: IDBValidKey | IDBKeyRange, count?: number): 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.
Parameters
Optionalquery: IDBValidKey | IDBKeyRangeOptionalcount: number
Returns IDBRequest<any[]>
getAllKeys
- getAllKeys(
query?: IDBValidKey | IDBKeyRange,
count?: number,
): 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.
Parameters
Optionalquery: IDBValidKey | IDBKeyRangeOptionalcount: number
Returns IDBRequest<IDBValidKey[]>
getKey
- getKey(query: IDBValidKey | IDBKeyRange): 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.
Parameters
- query: IDBValidKey | IDBKeyRange
Returns IDBRequest<IDBValidKey>
openCursor
- openCursor(
query?: IDBValidKey | IDBKeyRange,
direction?: IDBCursorDirection,
): 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.
Parameters
Optionalquery: IDBValidKey | IDBKeyRangeOptionaldirection: IDBCursorDirection
Returns IDBRequest<IDBCursorWithValue>
openKeyCursor
- openKeyCursor(
query?: IDBValidKey | IDBKeyRange,
direction?: IDBCursorDirection,
): 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.
Parameters
Optionalquery: IDBValidKey | IDBKeyRangeOptionaldirection: IDBCursorDirection
Returns IDBRequest<IDBCursor>
IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.
MDN Reference