Skip to content
Experimental WebAPI

IDBDatabase

Values

addEventListener

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener: (
  IndexedDbTypes.idbDatabase,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

IndexedDbTypes.idbDatabase EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListenerWithCapture: (
  IndexedDbTypes.idbDatabase,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

IndexedDbTypes.idbDatabase EventTypes.eventType EventTypes.eventListener

Return type

unit

asEventTarget

let asEventTarget: IndexedDbTypes.idbDatabase => EventTypes.eventTarget

Parameters

IndexedDbTypes.idbDatabase

Return type

EventTypes.eventTarget

close

Closes the connection once all running transactions have finished. Read more on MDN

let close: IndexedDbTypes.idbDatabase => unit

Parameters

IndexedDbTypes.idbDatabase

Return type

unit

createObjectStore

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. Read more on MDN

let createObjectStore: (
  IndexedDbTypes.idbDatabase,
  ~name: string,
  ~options: IndexedDbTypes.idbObjectStoreParameters=?,
) => IndexedDbTypes.idbObjectStore

Parameters

IndexedDbTypes.idbDatabase string option< IndexedDbTypes.idbObjectStoreParameters >

Return type

IndexedDbTypes.idbObjectStore

deleteObjectStore

Deletes the object store with the given name.

Throws a "InvalidStateError" DOMException if not called within an upgrade transaction. Read more on MDN

let deleteObjectStore: (IndexedDbTypes.idbDatabase, string) => unit

Parameters

IndexedDbTypes.idbDatabase string

Return type

unit

dispatchEvent

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. Read more on MDN

let dispatchEvent: (IndexedDbTypes.idbDatabase, EventTypes.event) => bool

Parameters

IndexedDbTypes.idbDatabase EventTypes.event

Return type

bool

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  IndexedDbTypes.idbDatabase,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

IndexedDbTypes.idbDatabase EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListenerUseCapture: (
  IndexedDbTypes.idbDatabase,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

IndexedDbTypes.idbDatabase EventTypes.eventType EventTypes.eventListener

Return type

unit

transaction

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. Read more on MDN

let transaction: (
  IndexedDbTypes.idbDatabase,
  ~storeNames: string,
  ~mode: IndexedDbTypes.idbTransactionMode=?,
  ~options: IndexedDbTypes.idbTransactionOptions=?,
) => IndexedDbTypes.idbTransaction

Parameters

IndexedDbTypes.idbDatabase string option< IndexedDbTypes.idbTransactionMode > option< IndexedDbTypes.idbTransactionOptions >

Return type

IndexedDbTypes.idbTransaction

transaction2

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. Read more on MDN

let transaction2: (
  IndexedDbTypes.idbDatabase,
  ~storeNames: array<string>,
  ~mode: IndexedDbTypes.idbTransactionMode=?,
  ~options: IndexedDbTypes.idbTransactionOptions=?,
) => IndexedDbTypes.idbTransaction

Parameters

IndexedDbTypes.idbDatabase array< string > option< IndexedDbTypes.idbTransactionMode > option< IndexedDbTypes.idbTransactionOptions >

Return type

IndexedDbTypes.idbTransaction