Interface IDBFactory

In the following code snippet, we make a request to open a database, and include handlers for the success and error cases. For a full working example, see our To-do Notifications app (view example live.)

interface IDBFactory {
    cmp(first, second): number;
    databases(): Promise<IDBDatabaseInfo[]>;
    deleteDatabase(name): IDBOpenDBRequest;
    open(name, version?): IDBOpenDBRequest;
}

Methods

cmp databases deleteDatabase open

Methods

cmp

  • cmp(first, second): number

  • Compares two values as keys. Returns -1 if key1 precedes key2, 1 if key2 precedes key1, and 0 if the keys are equal.

    Throws a "DataError" DOMException if either input is not a valid key.

    Parameters

    • first: any
    • second: any

    Returns number

databases

  • databases(): Promise<IDBDatabaseInfo[]>

  • Returns Promise<IDBDatabaseInfo[]>

deleteDatabase

  • deleteDatabase(name): IDBOpenDBRequest

  • Attempts to delete the named database. If the database already exists and there are open connections that don't close in response to a versionchange event, the request will be blocked until all they close. If the request is successful request's result will be null.

    Parameters

    • name: string

    Returns IDBOpenDBRequest

open

  • open(name, version?): IDBOpenDBRequest

  • Attempts to open a connection to the named database with the current version, or 1 if it does not already exist. If the request is successful request's result will be the connection.

    Parameters

    • name: string
    • Optional version: number

    Returns IDBOpenDBRequest

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc