search

axemclion / jquery-indexeddb

An IndexedDB Plugin for Jquery.
Other
195 stars 70 forks source link
indexeddb-api jquery-indexeddb jquery-plugin

readme

Jquery Plugin for the IndexedDB API Build Status

IndexedDB is a database inside a browser to save and retrieve objects on the browser/client. The JQuery IndexedDB Plugin is a wrapper on the IndexedDB API for JQuery.

Links

Summary

The Jquery IndexedDB Plugin brings to goodness of Jquery to the browser's native IndexedDB API. It supports method chaining, promises and smart defaults, enabling you to get more done with less code. It also abstracts out differences in browser implementations.

Code

The code written with the jQuery plugin is pretty simple. It looks something like 

    $.indexeddb("BookShop-1").objectStore("BookList").openCursor().each(write);

A typical operation using the IndexedDB API would involve using the request model, creating transactions, checking for existence of object store using error responses and exceptions and then finally getting to the part where the data is actually iterated over. 

    var request = window.indexedDB.open("BookShop-1");
    request.onsuccess = function(event){
        var db = request.result;
        var transaction = db.transaction(["BookList"], IDBTransaction.READ_WRITE);
        var objectStore = transaction.objectStore("BookList");
        var request = DAO.objectStore.openCursor();
        request.onsuccess = function(event){
            var cursor = request.result;
            if (cursor) {
              write(cursor.key + "" + cursor.value);
              cursor["continue"]();                
            }
        };
    };

Read more about the API syntax in the documentation.

Building

Node is required to build this project.