Interface IDBRequest<T>

The request object does not initially contain any information about the result of the operation, but once information becomes available, an event is fired on the request, and the information becomes available through the properties of the IDBRequest instance.

interface IDBRequest {
    error: DOMException;
    onerror: ((this, ev) => any);
    onsuccess: ((this, ev) => any);
    readyState: IDBRequestReadyState;
    result: T;
    source: IDBCursor | IDBObjectStore | IDBIndex;
    transaction: IDBTransaction;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
}

Type Parameters

  • T = any

Hierarchy

  • EventTarget
    • IDBRequest

Properties

error onerror onsuccess readyState result source transaction

Methods

addEventListener dispatchEvent removeEventListener

Properties

Readonly error

error: DOMException

When a request is completed, returns the error (a DOMException), or null if the request succeeded. Throws a "InvalidStateError" DOMException if the request is still pending.

onerror

onerror: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onsuccess

onsuccess: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

Readonly readyState

readyState: IDBRequestReadyState

Returns "pending" until a request is complete, then returns "done".

Readonly result

result: T

When a request is completed, returns the result, or undefined if the request failed. Throws a "InvalidStateError" DOMException if the request is still pending.

Readonly source

source: IDBCursor | IDBObjectStore | IDBIndex

Returns the IDBObjectStore, IDBIndex, or IDBCursor the request was made against, or null if is was an open request.

Readonly transaction

transaction: IDBTransaction

Returns the IDBTransaction the request was made within. If this as an open request, then it returns an upgrade transaction while it is running, or null otherwise.

Methods

addEventListener

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

  • Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

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.

    Parameters

    • event: Event

    Returns boolean

removeEventListener

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

  • Type Parameters

    Parameters

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc