Table.mapToClass()

Map the table to an existing javascript class

Syntax

table.mapToClass(constructor, structure)

Parameters

constructor: Function	Javascript constructor function
structure: Object	Definition of the properties available on instances of the class	optional

Return Value

Same constructor function as given as argument.

Remarks

Makes any object extracted from this table be instanceof your given constructor function. You could extend the prototype of the given constructor with methods that will be available on all objects returned by the database.

If calling this method before db.open() call, intelligent javascript editors like Visual Studio 2012+ and IntelliJ will be able to do autocomplete for all objects returned by the database, based on the prototype of the constructor and on given structure.

Sample

function Car() {
}

function Friend() {
}

Friend.prototype.log = function () {
    console.log(JSON.stringify(this));
}

var db = new Dexie("FriendsDB");

// The stores() method just specify primary key and indexes
db.version(1).stores({
    friends: "++id,name,shoeSize"
});

// Using a structure, you may specify non-indexed properties as well and their types
db.friends.mapToClass (Friend, {
    name: String,
    shoeSize: Number,
    cars: [Car],
    address: {
        street: String,
        city: String,
        country: String
    }        
});

db.open();

db.friends.where("name").startsWithIgnoreCase("d").each(function(friend) {
    friend.log();
}).catch(function (e) {
    console.error(e);
});

See Also

Table.defineClass()