Skip to content

@ralphschuler.webgl shader factory.<internal>.IDBDatabase

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: IDBDatabase

@ralphschuler/webgl-shader-factory.<internal>.IDBDatabase

This IndexedDB API interface 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. The interface provides the only way to get and manage versions of the database.

MDN Reference

Hierarchy

  • EventTarget

    IDBDatabase

Table of contents

Properties

Methods

Properties

name

Readonly name: string

Returns the name of the database.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13603


objectStoreNames

Readonly objectStoreNames: DOMStringList

Returns a list of the names of object stores in the database.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13609


onabort

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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13610


onclose

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

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13612


onerror

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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13613


onversionchange

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

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13615


version

Readonly version: number

Returns the version of the database.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13621

Methods

addEventListener

addEventListener<K>(type, listener, options?): void

Type parameters

Name Type
K extends keyof IDBDatabaseEventMap

Parameters

Name Type
type K
listener (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any
options? boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13650

addEventListener(type, listener, options?): void

Parameters

Name Type
type string
listener EventListenerOrEventListenerObject
options? boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13651


close

close(): void

Closes the connection once all running transactions have finished.

MDN Reference

Returns

void

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13627


createObjectStore

createObjectStore(name, options?): IDBObjectStore

Creates a new object store with the given name and options and returns a new IDBObjectStore.

Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.

MDN Reference

Parameters

Name Type
name string
options? IDBObjectStoreParameters

Returns

IDBObjectStore

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13635


deleteObjectStore

deleteObjectStore(name): void

Deletes the object store with the given name.

Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.

MDN Reference

Parameters

Name Type
name string

Returns

void

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13643


dispatchEvent

dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

Name Type
event Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8217


removeEventListener

removeEventListener<K>(type, listener, options?): void

Type parameters

Name Type
K extends keyof IDBDatabaseEventMap

Parameters

Name Type
type K
listener (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any
options? boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13652

removeEventListener(type, listener, options?): void

Parameters

Name Type
type string
listener EventListenerOrEventListenerObject
options? boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13653


transaction

transaction(storeNames, mode?, options?): IDBTransaction

Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.

MDN Reference

Parameters

Name Type
storeNames string | string[]
mode? IDBTransactionMode
options? IDBTransactionOptions

Returns

IDBTransaction

Defined in

node_modules/typescript/lib/lib.dom.d.ts:13649

Typescript Libraries

Modules

Namespaces

Clone this wiki locally