https://github.com/axemclion/jquery-indexeddb
An IndexedDB Plugin for Jquery.
https://github.com/axemclion/jquery-indexeddb
indexeddb-api jquery-indexeddb jquery-plugin
Last synced: about 1 year ago
JSON representation
An IndexedDB Plugin for Jquery.
- Host: GitHub
- URL: https://github.com/axemclion/jquery-indexeddb
- Owner: axemclion
- License: other
- Created: 2011-12-24T01:26:46.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2018-01-10T01:20:51.000Z (over 8 years ago)
- Last Synced: 2025-04-10T03:57:19.607Z (about 1 year ago)
- Topics: indexeddb-api, jquery-indexeddb, jquery-plugin
- Language: JavaScript
- Homepage:
- Size: 373 KB
- Stars: 195
- Watchers: 24
- Forks: 70
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Jquery Plugin for the IndexedDB API [](https://travis-ci.org/axemclion/jquery-indexeddb)
===============================================================================================================================================================================
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
------
* Home page - http://nparashuram.com/jquery-indexeddb/index.html
* Download the plugin - http://nparashuram.com/jquery-indexeddb/jquery.indexeddb.js
* Sample application - http://nparashuram.com/jquery-indexeddb/example/index.html
* API Documentation - https://github.com/axemclion/jquery-indexeddb/blob/gh-pages/docs/README.md
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
```javascript
$.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.
```javascript
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](https://github.com/axemclion/jquery-indexeddb/blob/master/docs/README.md).
Building
--------
Node is required to build this project.
* `npm insall -g grunt-cli` # to install the grunt command line
* `npm install` # to install all other dependencies from the package.json
* Run one of the following grunt commands
* `grunt` # to just minify, lint and build the source. Final file available in `dist/` folder
* `grunt dev` # to start a web server. Navigate to `http://127.0.0.1:8080/test/` to run Qunit tests