IDBRequest.onsuccess

The onsuccess event handler of the IDBRequest interface handles the success event, fired when the result of a request is successfully returned.

The event handler takes one parameter, a success Event with type="success".

Note: This feature is available in Web Workers.

Syntax

request.onsuccess = function(event) { ... };

Example

The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store. For a full working example, see our To-do Notifications app (view example live.)

var title = "Walk dog";

// Open up a transaction as usual
var objectStore = db.transaction(['toDoList'], "readwrite").objectStore('toDoList');

// Get the to-do list object that has this title as it's title
var objectStoreTitleRequest = objectStore.get(title);

objectStoreTitleRequest.onsuccess = function() {
  // Grab the data object returned as the result
  var data = objectStoreTitleRequest.result;
 
  // Update the notified value in the object to "yes"
  data.notified = "yes";
 
  // Create another request that inserts the item back
  // into the database
  var updateTitleRequest = objectStore.put(data);
 
  // When this new request succeeds, run the displayData()
  // function again to update the display
  updateTitleRequest.onsuccess = function() {
    displayData();
  };
};

Specifications

Specification Status Comment
Indexed Database API
The definition of 'onsuccess' in that specification.
Recommendation  
Indexed Database API 2.0
The definition of 'onsuccess' in that specification.
Recommendation  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support

24

23 webkit

12

16

10 — 16 moz

101157
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes Yes Yes22228 Yes

1. partial

See also

Document Tags and Contributors

 Contributors to this page: fscholz, jpmedley, libbymc, rolfedh, robincafolla, chrisdavidmills
 Last updated by: fscholz,