DataStore.clear()

The clear() method of the DataStore interface deletes all records from the data store, leaving it empty.

Syntax

store.clear().then(function(success) {
  // Do something with success, which is a boolean 
  // reporting whether the deletion was successful or not

Returns

A Promise object of type void that resolves with boolean reporting whether the deletion was successful or not.

Parameters

revisionId

You can specify an optional 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 deletes all the content in the first "contacts" data store:

navigator.getDataStores('contacts').then(function(stores) {
  stores[0].clear.then(function(success) {
    if(success) {
      console.log('Contacts successfully cleared.');
    };
  });
});

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