@nextcloud/dialogs
    Preparing search index...

    Interface IDBDatabase

    The IDBDatabase interface of the IndexedDB API provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database.

    MDN Reference

    interface IDBDatabase {
        name: string;
        objectStoreNames: DOMStringList;
        onabort: ((this: IDBDatabase, ev: Event) => any) | null;
        onclose: ((this: IDBDatabase, ev: Event) => any) | null;
        onerror: ((this: IDBDatabase, ev: Event) => any) | null;
        onversionchange:
            | ((this: IDBDatabase, ev: IDBVersionChangeEvent) => any)
            | null;
        version: number;
        addEventListener<K extends keyof IDBDatabaseEventMap>(
            type: K,
            listener: (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(): void;
        createObjectStore(
            name: string,
            options?: IDBObjectStoreParameters,
        ): IDBObjectStore;
        deleteObjectStore(name: string): void;
        dispatchEvent(event: Event): boolean;
        removeEventListener<K extends keyof IDBDatabaseEventMap>(
            type: K,
            listener: (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        transaction(
            storeNames: string | string[],
            mode?: IDBTransactionMode,
            options?: IDBTransactionOptions,
        ): IDBTransaction;
    }

    Hierarchy

    • EventTarget
      • IDBDatabase
    Index

    Properties

    name objectStoreNames onabort onclose onerror onversionchange version

    Methods

    addEventListener close createObjectStore deleteObjectStore dispatchEvent removeEventListener transaction

    Properties

    name: string

    The name read-only property of the IDBDatabase interface is a string that contains the name of the connected database.

    MDN Reference

    objectStoreNames: DOMStringList

    The objectStoreNames read-only property of the list of the names of the object stores currently in the connected database.

    MDN Reference

    onabort: ((this: IDBDatabase, ev: Event) => any) | null
    onclose: ((this: IDBDatabase, ev: Event) => any) | null

    MDN Reference

    onerror: ((this: IDBDatabase, ev: Event) => any) | null
    onversionchange: ((this: IDBDatabase, ev: IDBVersionChangeEvent) => any) | null

    MDN Reference

    version: number

    The version property of the IDBDatabase interface is a 64-bit integer that contains the version of the connected database.

    MDN Reference

    Methods

    • The close() method of the IDBDatabase interface returns immediately and closes the connection in a separate thread.

      MDN Reference

      Returns void

    • The deleteObjectStore() method of the the connected database, along with any indexes that reference it.

      MDN Reference

      Parameters

      • name: string

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods