Logos DX
    Preparing search index...

    Interface IDBObjectStore

    The IDBObjectStore interface of the IndexedDB API represents an object store in a database.

    MDN Reference

    interface IDBObjectStore {
        autoIncrement: boolean;
        indexNames: DOMStringList;
        keyPath: string | string[] | null;
        name: string;
        transaction: IDBTransaction;
        add(value: any, key?: IDBValidKey): IDBRequest<IDBValidKey>;
        clear(): IDBRequest<undefined>;
        count(query?: IDBValidKey | IDBKeyRange): IDBRequest<number>;
        createIndex(
            name: string,
            keyPath: string | string[],
            options?: IDBIndexParameters,
        ): IDBIndex;
        delete(query: IDBValidKey | IDBKeyRange): IDBRequest<undefined>;
        deleteIndex(name: string): void;
        get(query: IDBValidKey | IDBKeyRange): IDBRequest<any>;
        getAll(
            query?: IDBValidKey | IDBKeyRange | null,
            count?: number,
        ): IDBRequest<any[]>;
        getAllKeys(
            query?: IDBValidKey | IDBKeyRange | null,
            count?: number,
        ): IDBRequest<IDBValidKey[]>;
        getKey(
            query: IDBValidKey | IDBKeyRange,
        ): IDBRequest<IDBValidKey | undefined>;
        index(name: string): IDBIndex;
        openCursor(
            query?: IDBValidKey | IDBKeyRange | null,
            direction?: IDBCursorDirection,
        ): IDBRequest<IDBCursorWithValue | null>;
        openKeyCursor(
            query?: IDBValidKey | IDBKeyRange | null,
            direction?: IDBCursorDirection,
        ): IDBRequest<IDBCursor | null>;
        put(value: any, key?: IDBValidKey): IDBRequest<IDBValidKey>;
    }
    Index

    Properties

    autoIncrement indexNames keyPath name transaction

    Methods

    add clear count createIndex delete deleteIndex get getAll getAllKeys getKey index openCursor openKeyCursor put

    Properties

    autoIncrement: boolean

    The autoIncrement read-only property of the for this object store.

    MDN Reference

    indexNames: DOMStringList

    The indexNames read-only property of the in this object store.

    MDN Reference

    keyPath: string | string[] | null

    The keyPath read-only property of the If this property is null, the application must provide a key for each modification operation.

    MDN Reference

    name: string

    The name property of the IDBObjectStore interface indicates the name of this object store.

    MDN Reference

    transaction: IDBTransaction

    The transaction read-only property of the object store belongs.

    MDN Reference

    Methods

    • The clear() method of the IDBObjectStore interface creates and immediately returns an IDBRequest object, and clears this object store in a separate thread.

      MDN Reference

      Returns IDBRequest<undefined>

    • The createIndex() method of the field/column defining a new data point for each database record to contain.

      MDN Reference

      Parameters

      Returns IDBIndex

    • The deleteIndex() method of the the connected database, used during a version upgrade.

      MDN Reference

      Parameters

      • name: string

      Returns void

    • The index() method of the IDBObjectStore interface opens a named index in the current object store, after which it can be used to, for example, return a series of records sorted by that index using a cursor.

      MDN Reference

      Parameters

      • name: string

      Returns IDBIndex

    Settings

    Member Visibility

    On This Page

    Properties
    Methods