---
title: "IDBRequest | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface IDBRequest<T>

The **`IDBRequest`** interface of the IndexedDB API provides access to results of asynchronous requests to databases and database objects using event handler attributes. Each reading and writing operation on a database is done using a request.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest)

interface IDBRequest<[T](#t) \= any\> {  
    [error](#error): DOMException | null;  
    [onerror](#onerror): ((this: IDBRequest<[T](#t)\>, ev: Event) \=> any) | null;  
    [onsuccess](#onsuccess): ((this: IDBRequest<[T](#t)\>, ev: Event) \=> any) | null;  
    [readyState](#readystate): [IDBRequestReadyState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.IDBRequestReadyState/);  
    [result](#result): [T](#t);  
    [source](#source): [IDBObjectStore](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBObjectStore/) | [IDBIndex](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBIndex/) | [IDBCursor](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBCursor/);  
    [transaction](#transaction): [IDBTransaction](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBTransaction/) | null;  
    [addEventListener](#addeventlistener-1)<[K](#addeventlistenerk) extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addEventListener](#addeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [dispatchEvent](#dispatchevent-1)(event: Event): boolean;  
    [removeEventListener](#removeeventlistener-1)<[K](#removeeventlistenerk) extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeEventListener](#removeeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void;  
}

#### Type Parameters

-   T = any

#### Hierarchy ([View Summary](https://docs.maptiler.com/sdk-js/api-reference/hierarchy/#Externals.IDBRequest))

-   EventTarget
    -   IDBRequest
        -   [IDBOpenDBRequest](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBOpenDBRequest/)

##### Index

### Properties[](#properties)

[error](#error) [onerror](#onerror) [onsuccess](#onsuccess) [readyState](#readystate) [result](#result) [source](#source) [transaction](#transaction)

### Methods[](#methods)

[addEventListener](#addeventlistener) [dispatchEvent](#dispatchevent) [removeEventListener](#removeeventlistener)

## Properties[](#properties-1)

### `Readonly`error[](#error)

error: DOMException | null

The **`error`** read-only property of the IDBRequest interface returns the error in the event of an unsuccessful request.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/error)

### onerror[](#onerror)

onerror: ((this: IDBRequest<[T](#t)\>, ev: Event) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/error_event)

### onsuccess[](#onsuccess)

onsuccess: ((this: IDBRequest<[T](#t)\>, ev: Event) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/success_event)

### `Readonly`readyState[](#readystate)

readyState: [IDBRequestReadyState](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.IDBRequestReadyState/)

The **`readyState`** read-only property of the IDBRequest interface returns the state of the request.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/readyState)

### `Readonly`result[](#result)

result: [T](#t)

The **`result`** read-only property of the IDBRequest interface returns the result of the request.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/result)

### `Readonly`source[](#source)

source: [IDBObjectStore](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBObjectStore/) | [IDBIndex](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBIndex/) | [IDBCursor](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBCursor/)

The **`source`** read-only property of the IDBRequest interface returns the source of the request, such as an Index or an object store. If no source exists (such as when calling IDBFactory.open), it returns null.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/source)

### `Readonly`transaction[](#transaction)

transaction: [IDBTransaction](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBTransaction/) | null

The **`transaction`** read-only property of the IDBRequest interface returns the transaction for the request, that is, the transaction the request is being made inside.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBRequest/transaction)

## Methods[](#methods-1)

### addEventListener[](#addeventlistener)

-   addEventListener<[K](#addeventlistenerk) extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-1)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)
    
    #### Parameters
    
    -   type: [K](#addeventlistenerk)
    -   listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#addeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    
-   addEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-2)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    

### dispatchEvent[](#dispatchevent)

-   dispatchEvent(event: Event): boolean[](#dispatchevent-1)
    
    The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
    
    #### Parameters
    
    -   event: Event
    
    #### Returns boolean
    
    Inherited from EventTarget.dispatchEvent
    

### removeEventListener[](#removeeventlistener)

-   removeEventListener<[K](#removeeventlistenerk) extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-1)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Type Parameters
    
    -   K extends keyof [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)
    
    #### Parameters
    
    -   type: [K](#removeeventlistenerk)
    -   listener: (this: IDBRequest<[T](#t)\>, ev: [IDBRequestEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.IDBRequestEventMap/)\[[K](#removeeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    
-   removeEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-2)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener