DataStore.remove()

The remove() method of the DataStore interface deletes one or more objects from the current data store.

Syntax

store.remove(1).then(function(success) {
  // Do something with success, which is a boolean communicating 
  // the result of whether the deletion was successful or not
});

Returns

A Promise object of type Boolean that resolves with a boolean communicating the result of whether the deletion was successful or not.

Parameters

id

remove() can be passed one or more ids of specific records that you want to delete from the data store. When you want to delete multiple ids, you pass them in as multiple parameters, rather than an array or object, e.g. remove(1,2,3).

revisionId

You can specify an optional second parameter that will be a revisionId (a DOMString). This can be used to prevent conflicts. If the revisionId is not the current revisionId for the current Data Store, the operation is aborted. This means that the developer has a 'old' revisionId and will have to manage the conflict somehow.

Example

The following example gets all the data stores on the device called "contacts", then removes the first three records stored in the first "contacts" data store:

navigator.getDataStores('contacts').then(function(stores) {
  stores[0].remove(1,2,3).then(function(success) {
    if(success) {
      console.log('Records successfully removed.');
    };
  });
});

Specifications

The discussion concerning this API's creation happened in various Mozilla mailing lists and other places. A summary of the discussion and further pointers can be found on the Mozilla Wiki. For further feedback and questions, send mail to the dev-webapi mailing list.

Browser compatibility

See also

• Using the Data Store API
• Data Store Contacts Editor example
• Data Store Contacts Viewer example