Fork me on GitHub

IDBWrapper

A cross-browser wrapper for IndexedDB.

About

This is a wrapper for indexedDB. It is meant to

a) ease the use of indexedDB and abstract away the differences between the existing impls in Chrome, Firefox and IE10 (yes, it works in all three), and

b) show how IDB works. The code is split up into short methods, so that it's easy to see what happens in what method.

There are two tutorials to get you up and running:

Part 1: Setup and CRUD operations http://jensarps.de/2011/11/25/working-with-idbwrapper-part-1/

Part 2: Running Queries against the store http://jensarps.de/2012/11/13/working-with-idbwrapper-part-2/

API Reference

There's an API reference right here.

You can create a local version of the reference using a terminal. Go into the IDBWrapper directory and run the following command:

$ make doc

Obtaining IDBWrapper

You can git clone the repository, or download a zip file here: https://github.com/jensarps/IDBWrapper/tags

IDBWrapper is also available on cdnjs, so you can directly point a script tag there, or require() it from there. The URL is:

//cdnjs.cloudflare.com/ajax/libs/idbwrapper/1.0.0/idbstore.min.js

If you use NPM as your package manager, you can get it from there, too, by running:

$ npm install idb-wrapper

If you use bower as your package manager, run the following:

$ bower install idbwrapper

If you want to add IDBWrapper to a volo project, just run:

$ volo add idbwrapper

Usage

For details on usage, please see the project's README and check out the examples:

Dependencies

None.

License

MIT style (X11)

Author

Jens Arps

Contact

Ping me on Twitter: @jensarps

Download

You can download this project in either zip or tar formats.

You can also clone the project with Git by running:

$ git clone git://github.com/jensarps/IDBWrapper