https://github.com/lrlna/nanoidb
fun wrapper around IndexedDB
https://github.com/lrlna/nanoidb
indexeddb wrapper
Last synced: 1 day ago
JSON representation
fun wrapper around IndexedDB
- Host: GitHub
- URL: https://github.com/lrlna/nanoidb
- Owner: lrlna
- License: mit
- Created: 2017-05-14T10:58:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-09T15:13:48.000Z (about 7 years ago)
- Last Synced: 2025-09-12T04:22:13.017Z (25 days ago)
- Topics: indexeddb, wrapper
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 45
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nanoidb
[![npm version][1]][2] [![build status][3]][4]
[![downloads][5]][6] [![js-standard-style][7]][8]
IndexedDB is a web-api for client-side storage, and although widely used, the API
itself is at times confusing. Nanoidb is small wrapper to help standardize most
useful methods in a callback based fashion.
IndexedDB is an async transactional database that lets you store objects as
`` pairs. The pairs get stored in object stores that are
essentially a set of database tables, but in an indexedDB context.
# Usage
```js
var db = Nanoidb('catStore', 1)
db.on('upgrade', function (diffData) {
diffData.db.createObjectStore('catStore')
})
db.on('open', function (stores) {
putOp(stores.catStore)
function putOp (store) {
stores.catStore.put('key-12345', 'ChashuCat', function (err) {
if (err) throw err
console.log('put done')
batchOp(stores.catStore)
getOp(stores.catStore)
getAllOp(stores.catStore)
})
}
function getAllOp (store) {
store.getAll('dang', 10, function (err, values) {
if (err) throw err
values.forEach(function (value) {
console.log('new value', value)
})
})
}
function getOp (store) {
store.get('key-12345', function (err, val) {
if (err) throw err
console.log('get value', val)
deleteOp(store)
})
}
function deleteOp (store) {
store.del('catStore', function (err) {
if (err) throw err
console.log('deleted')
batchOp(store)
})
}
function batchOp (store) {
store.batch()
.put('coolThang', 'hell yea')
.put('dang', 'no wayyy')
.put('ding', 'whoaaa yea')
.del('ding')
.flush(function (err) {
if (err) throw err
console.log('it flushed successfully')
})
}
})
```
## API
### `db = Nanoidb(name, version)`
This creates an instance of IndexedDB. It takes in a database `name` and
`version`. IndexedDB's versioning starts with 1, rather than 0.
### `db.upgrade(version)`
Upgrades the current version of Nanoidb with the specified version. This is
useful for when you need to create an extra `object store` under the same
Nanoidb instance.
### `db.on('upgrade', callback(diffData))`
Returns an object composed of a previously created indexedDB and a
IDBVersionChangeEvent. This is where you should create your object store by
calling `diffData.db.createObjectStore('')`.
`diffData.event` provides you with an `oldVersion` property to help with
schema updates.
### `db.on('open', callback(stores))`
Returns an instance of an object store that you can later use.
### `db.on('error', callback(error))`
Returns an IndexedDB error object. This event will be sent when IndexedDB runs
into an error creating a database.
### `store = stores.`
Instance of an Object Store.
### `store.put(key, val, callback(err))`
Given the Object Store you previously created, you can add a value to the
database via the `put` method. Takes an object `key`, `val`, and an error
callback.
### `store.get(key, callback(err, val))`
You can also get a value from the database with a `get`. Takes a `key` and an
error callback.
### `store.getAll([query, count], callback(err, val))`
Get all records in a given store. Can optionally take a [query
key](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAll) or
range, as well as a count for values to be returned if there are duplicates.
Will return all records if neither `query` nor `count` are provided.
### `store.del(key, callback(err))`
Delete method takes a `key` and an error callback.
### `batch = store.batch()`
You can also batch chain `del` and `get` methods. When you're done, you have to
call a `.flush()` to handle your callback.
### `batch.put(key, val)`
Add an object within a batch operation. Takes a `key` and a `val`.
### `batch.del(key)`
Delete an object within a batch operation. Takes a `key`.
### `batch.flush(callback(err))`
When working with a `batch()` method, you have to call a flush to handle your
errors. This just takes an error callback.
# Install
```bash
npm install nanoidb
```
# Related content
- [choo](https://github.com/yoshuawuyts/choo)
- [mdn/IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
## License
[MIT](https://tldrlegal.com/license/mit-license)
[1]: https://img.shields.io/npm/v/nanoidb.svg?style=flat-square
[2]: https://npmjs.org/package/nanoidb
[3]: https://img.shields.io/travis/lrlna/nanoidb/master.svg?style=flat-square
[4]: https://travis-ci.org/lrlna/nanoidb
[5]: http://img.shields.io/npm/dm/nanoidb.svg?style=flat-square
[6]: https://npmjs.org/package/nanoidb
[7]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[8]: https://github.com/feross/standard