Skip to content

DexieError

David Fahlander edited this page Sep 22, 2016 · 28 revisions

since v.1.3.3

class DexieError extends Error {}

Acts as the base class for exceptions that can be returned in rejected Dexie promises.

Inheritance Hierarchy

Sample

doSomeDatabaseWork().then(function(){
    //
    // Success
    //
}).catch(Dexie.ModifyError, function (e) {
    //
    // Failed with ModifyError. Check out e.failures
    //
    console.error ("ModifyError occurred: " + e.failures.length + " failures"); +
}).catch(Dexie.DexieError, function (e) {
    //
    // Any other Dexie related error occurred
    //
    console.error ("Error: " + e.message);
}).catch(function (e) {
    //
    // Other error such as a string was thrown
    //
    console.error ("Other unknown error catched: " + e);
});

Sample (ES6)

Dexie.spawn(function*(){
    try {
        yield doSomeDatabaseWork();
    } catch (e) {
        if (e instanceof Dexie.ModifyError) {
            // Failed with ModifyError. Check out e.failures
            console.error ("ModifyError occurred: " + e.failures.length +
             " failures and " + e.successCount + " successful operations");
        } else if (e instanceof Dexie.DexieError) {
            // Any other Dexie related error occurred
            console.error ("Error: " + e.message);
        } else {
            // Other error such as a string was thrown
            console.error (e);
        }
    }
});

Sample: switch(error.name)

doSomeDatabaseWork().then(function(){
    // Success
}).catch(function (error) {
    switch (error.name) {
        case "UpgradeError": // or case Dexie.errnames.Upgrade: ...
            console.error ("Upgrade error");
            break;
        case "ModifyError": // or case Dexie.errnames.Modify: ...
            console.error ("Modify error");
            break;
        case ...

        default:
            console.error ("error: " + e);
    }
});

Properties

name: string Name of the error
message: string Detailed message
inner?: any Inner exception instance (if any)
stack?: string Can be present if the error was thown. If signaled, there wont be any call stack.

Catching Errors Affect Transaction

If explicitely catching an error, the ongoing transaction will NOT abort. If that is not your desire, for example if you are just catching the error for logging purpose, you should rethrow the error after logging it.

The catch effect also applies when using yield or async / await and a standard try..catch.

Sample of rethrowing error

db.transaction('rw', db.friends, function() {
    db.friends.add({id: 1, name: "Orvar", age: 3}).catch(function (e) {
        console.error ("Could not add Orvar");
        throw e; // Rethrowing so that transaction is indeed aborted.
    });
});

// Or with yield
db.transaction('rw', db.friends, function*() {
    try {
        yield db.friends.add({id: 1, name: "Orvar", age: 3});
    } catch (e) {
        console.error ("Could not add Orvar");
        throw e; // Rethrowing so that transaction is indeed aborted.
    });
});
Clone this wiki locally