Interface IDBIndex

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.

interface IDBIndex {
    keyPath: string | string[];
    multiEntry: boolean;
    name: string;
    objectStore: IDBObjectStore;
    unique: boolean;
    count(query?: IDBValidKey | IDBKeyRange): IDBRequest<number>;
    get(query: IDBValidKey | IDBKeyRange): IDBRequest<any>;
    getAll(query?: null | IDBValidKey | IDBKeyRange, count?: number): IDBRequest<any[]>;
    getAllKeys(query?: null | IDBValidKey | IDBKeyRange, count?: number): IDBRequest<IDBValidKey[]>;
    getKey(query: IDBValidKey | IDBKeyRange): IDBRequest<undefined | IDBValidKey>;
    openCursor(query?: null | IDBValidKey | IDBKeyRange, direction?: IDBCursorDirection): IDBRequest<null | IDBCursorWithValue>;
    openKeyCursor(query?: null | IDBValidKey | IDBKeyRange, direction?: IDBCursorDirection): IDBRequest<null | IDBCursor>;
}

Properties

keyPath multiEntry name objectStore unique

Methods

count get getAll getAllKeys getKey openCursor openKeyCursor

Properties

ReadonlykeyPath

keyPath: string | string[]

ReadonlymultiEntry

multiEntry: boolean

name

name: string

Returns the name of the index.

ReadonlyobjectStore

objectStore: IDBObjectStore

Returns the IDBObjectStore the index belongs to.

Readonlyunique

unique: boolean

Methods

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.

    Parameters

    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.

    Parameters

    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.

    Parameters

    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.

    Parameters

    Returns IDBRequest<IDBValidKey[]>

getKey

  • getKey(query): IDBRequest<undefined | 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

    Returns IDBRequest<undefined | IDBValidKey>

openCursor

  • openCursor(query?, direction?): IDBRequest<null | 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

    Returns IDBRequest<null | IDBCursorWithValue>

openKeyCursor

  • openKeyCursor(query?, direction?): IDBRequest<null | 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

    Returns IDBRequest<null | IDBCursor>

Settings

Member Visibility

On This Page

Properties
Methods